Skip to main content
POST
Create a credential

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required
platform_id
string
required
auth_method
enum<string>
required
Available options:
basic_auth,
api_key,
jwt,
oauth2,
aws_access_key
credentials
Credentials · object | null
credentials_ref
string | null
tenant_name
string | null
grant_type
string | null
token_url
string | null
scopes
string[]
audience
string | null
api_key_placement
ApiKeyPlacement · object | null

Where an API-key credential puts its key.

This is presentation configuration, not secret material: it holds the header NAME (and optionally a scheme such as Bearer prefixed to the value), or the query-parameter NAME. A form renders straight from it.

It is declared ONCE, on the credential, so every task that selects this credential injects the key identically and no task configuration ever mentions authentication. Exactly one of header_name or query_param is set; scheme is legal only alongside header_name.

aws_region
string | null
aws_default_bucket
string | null
aws_endpoint_url
string | null
status
enum<string>
default:active
Available options:
active,
expired,
revoked

Response

Successful Response

id
string
required
org_id
string
required
name
string
required
platform_id
string
required
auth_method
string
required
credentials_ref
string
required
status
string
required
created_by
string
required
tenancy_id
string | null
tenant
CredentialTenantSummary · object | null

The provider account or customer-named tenant this credential belongs to.

Example:
grant_type
string | null
token_url
string | null
scopes
string[]
audience
string | null
api_key_placement
ApiKeyPlacement · object | null

Where an API-key credential puts its key.

This is presentation configuration, not secret material: it holds the header NAME (and optionally a scheme such as Bearer prefixed to the value), or the query-parameter NAME. A form renders straight from it.

It is declared ONCE, on the credential, so every task that selects this credential injects the key identically and no task configuration ever mentions authentication. Exactly one of header_name or query_param is set; scheme is legal only alongside header_name.

aws_region
string | null
aws_default_bucket
string | null
aws_endpoint_url
string | null
telemetry
Telemetry · object
last_verified
string<date-time> | null
created_at
string<date-time> | null