Create a Credential

post

/api/v2/credentials/

Make a POST request to this resource with the following credential fields to create a new credential:

  • name: Name of this credential. (string, required)
  • description: Optional description of this credential. (string, default="")
  • organization: Inherit permissions from organization roles. If provided on creation, do not give either user or team. (id, default=None)
  • credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id, required)

  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

  • user: Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation. (id, default=None)

  • team: Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation. (id, default=None)

Request

Supported Media Types
Body ()
Root Schema : CredentialSerializerCreate
Type: object
Show Source
Nested Schema : Inputs
Type: object
Title: Inputs
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
Back to Top

Response

Supported Media Types

201 Response

Body ()
Root Schema : CredentialSerializerCreate
Type: object
Show Source
Nested Schema : Inputs
Type: object
Title: Inputs
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
Back to Top