Jump to

• Request
• Response

Create a Credential for an Inventory Source

post

/api/v2/inventory_sources/{id}/credentials/

Make a POST request to this resource with the following credential fields to create a new credential associated with this inventory source.

• name: Name of this credential. (string, required)
• description: Optional description of this credential. (string, default="")
• organization: (id, default=None)

• credential_type: Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type. (id, required)

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

Add Credentials for an Inventory Source:

Make a POST request to this resource with only an id field to associate an existing credential with this inventory source.

Remove Credentials from this Inventory Source:

Make a POST request to this resource with id and disassociate fields to remove the credential from this inventory source without deleting the credential.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Body ()

Root Schema : schema

Type: object

Show Source

• credential_type: integer
  Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type.
• description(optional): string
• inputs(optional): object inputs
  Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax.
• name: string
• organization(optional): integer

{
    "properties":{
        "credential_type":{
            "description":"Specify the type of credential you want to create. Refer to the Ansible Tower documentation for details on each type.",
            "type":"integer"
        },
        "description":{
            "description":"",
            "type":"string"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax.",
            "type":"object"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "organization":{
            "description":"",
            "type":"integer"
        }
    },
    "required":[
        "name",
        "credential_type"
    ],
    "type":"object"
}

Nested Schema : inputs

Type: object

Enter inputs using either JSON or YAML syntax. Refer to the Ansible Tower documentation for example syntax.

Back to Top

Response

Supported Media Types

• application/json

201 Response

400 Response

Body

Example Response (application/json)

{
    "msg":"Credentials of type insights and vault are disallowed for scm inventory sources."
}

Back to Top