Create a credential
Stores a new credential for authenticating with an external source. The credential is created immediately and can be used on task runs.
Authorizations
Secret key (sk_live_...)
Body
Request body for creating a new credential.
The source to authenticate against. Prefixed with src_.
Authentication method for the source. One of username_password, source_fields, or none. Defaults to none if not provided.
Credentials payload. Structure depends on auth_method. For username_password, pass username and password. For source_fields, pass at least one entry in source_fields. Any auth_method except none may also include source_fields alongside its credentials (for example, username and password plus source_fields in the same payload), and tokenized to vault selected source-field values.
An identifier from your system to associate with this credential. Max 255 characters. See the external IDs guide for multi-tenant patterns.
Persistence settings. Omit to leave persistence off.
Response
Created
Unique identifier for the credential, prefixed with cred_.
Always credential.
Credential status: unverified, verified, invalid, or deleted.
External identifier from your system, if set.
The source this credential authenticates against. Prefixed with src_.
Authentication method: username_password, source_fields, or none.
Summary of stored credentials. Sensitive values are not returned.
Persistence settings for this credential.
ISO 8601 timestamp of when the resource was created.
ISO 8601 timestamp of when the resource was last updated.
Unique identifier for the API request. Include this when contacting support.