Skip to main content

CreateCredentialRequest

Payload to store a new credential or rotate an existing one

namestringrequired
Example: acme-sftp-key
credentialTypeCredentialType (string)required

Type of credential secret

Possible values: [SSH_KEY, PASSWORD, API_TOKEN, AWS_ACCESS_KEY, AZURE_SAS, GCP_SERVICE_ACCOUNT, OAUTH2_CLIENT]

Example: SSH_KEY
usernamestring

Username (SSH_KEY, PASSWORD)

Example: sftp-user
passwordstring<password>

Password (PASSWORD type)

Example: s3cr3t!
privateKeystring

PEM-encoded private key (SSH_KEY type)

Example: -----BEGIN RSA PRIVATE KEY----- ...
tokenstring<password>

API token or bearer token (API_TOKEN type)

accessKeyIdstring

AWS access key ID (AWS_ACCESS_KEY type)

Example: AKIAIOSFODNN7EXAMPLE
secretAccessKeystring<password>

AWS secret access key (AWS_ACCESS_KEY type)

CreateCredentialRequest
{
"name": "acme-sftp-key",
"credentialType": "SSH_KEY",
"username": "sftp-user",
"password": "s3cr3t!",
"privateKey": "-----BEGIN RSA PRIVATE KEY-----\n...",
"token": "string",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "string"
}