Jump to

• Request
• Response

Retrieve a Credential

get

/api/v2/credentials/{id}/

Make GET request to this resource to retrieve a single credential record containing the following fields:

• id: Database ID for this credential. (integer)
• type: Data type for this credential. (choice)
• url: URL for this credential. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this credential was created. (datetime)
• modified: Timestamp when this credential was last modified. (datetime)
• name: Name of this credential. (string)
• description: Optional description of this credential. (string)
• organization: (id)
• credential_type: Specify the type of credential you want to create. Refer to the documentation for details on each type. (id)
• managed: (boolean)
• inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json)
• kind: (field)
• cloud: (field)
• kubernetes: (field)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : Credential

Type: object

Show Source

• cloud: string
  Title: Cloud

  Read Only: true
• created: string
  Title: Created

  Read Only: true
• credential_type(required): integer
  Title: Credential Type

  Specify the type of credential you want to create. Refer to the documentation for details on each type.
• description: string
  Title: Description
• id: integer
  Title: ID

  Read Only: true
• inputs: object Inputs
  Title: Inputs

  Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
• kind: string
  Title: Kind

  Read Only: true
• kubernetes: string
  Title: Kubernetes

  Read Only: true
• managed: string
  Title: Managed

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• organization: integer
  Title: Organization
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "cloud":{
            "readOnly":true,
            "title":"Cloud",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential_type":{
            "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.",
            "title":"Credential Type",
            "type":"integer"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Inputs",
            "type":"object"
        },
        "kind":{
            "readOnly":true,
            "title":"Kind",
            "type":"string"
        },
        "kubernetes":{
            "readOnly":true,
            "title":"Kubernetes",
            "type":"string"
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "credential_type"
    ],
    "type":"object"
}

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