Update a Credential Type
patch
/api/v2/credential_types/{id}/
Make a PUT or PATCH request to this resource to update this credential type. The following fields may be modified:
name
: Name of this credential type. (string, required)description
: Optional description of this credential type. (string, default=""
)-
kind
: (choice, required)net
: Networkcloud
: Cloud
-
inputs
: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={}
) injectors
: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={}
)
For a PATCH request, include only the fields that are being modified.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : CredentialType
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
injectors:
object Injectors
Title:
Injectors
Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. -
inputs:
object Inputs
Title:
Inputs
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. -
kind(required):
string
Title:
Kind
Allowed Values:[ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography" ]
-
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
-
namespace:
string
Title:
Namespace
Read Only:true
Minimum Length:1
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Nested Schema : Injectors
Type:
object
Title:
Injectors
Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
Nested Schema : Inputs
Type:
object
Title:
Inputs
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
Response
Supported Media Types
- application/json
200 Response
Root Schema : CredentialType
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
description:
string
Title:
Description
-
id:
integer
Title:
ID
Read Only:true
-
injectors:
object Injectors
Title:
Injectors
Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. -
inputs:
object Inputs
Title:
Inputs
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. -
kind(required):
string
Title:
Kind
Allowed Values:[ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography" ]
-
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
-
namespace:
string
Title:
Namespace
Read Only:true
Minimum Length:1
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
Nested Schema : Injectors
Type:
object
Title:
Injectors
Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
Nested Schema : Inputs
Type:
object
Title:
Inputs
Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.