Retrieve a Credential Type

get

/api/v2/credential_types/{id}/

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

  • id: Database ID for this credential type. (integer)
  • type: Data type for this credential type. (choice)
  • url: URL for this credential type. (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 type was created. (datetime)
  • modified: Timestamp when this credential type was last modified. (datetime)
  • name: Name of this credential type. (string)
  • description: Optional description of this credential type. (string)
  • kind: (choice)
    • ssh: Machine
    • vault: Vault
    • net: Network
    • scm: Source Control
    • cloud: Cloud
    • token: Personal Access Token
    • insights: Insights
    • external: External
    • kubernetes: Kubernetes
    • galaxy: Galaxy/Automation Hub
  • namespace: (string)
  • managed_by_tower: (boolean)
  • inputs: Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)
  • injectors: Enter injectors using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax. (json)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "id":1,
    "injectors":{
    },
    "inputs":{
    },
    "kind":"cloud",
    "managed_by_tower":false,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"Some Other Name",
    "namespace":null,
    "related":{
        "activity_stream":"/api/v2/credential_types/1/activity_stream/",
        "credentials":"/api/v2/credential_types/1/credentials/"
    },
    "summary_fields":{
        "user_capabilities":{
            "delete":true,
            "edit":true
        }
    },
    "type":"credential_type",
    "url":"/api/v2/credential_types/1/"
}
Back to Top