Skip to main content
POST
cURL

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json

Exactly one of these fields is required: basic or http_api_key or http_basic or http_bearer or iam or kubernetes or snowflake_key or ssh_key.

resourceId
string
Minimum string length: 1
useAsDefault
boolean
terminationProtection
boolean
basic
basic · object

One of the discriminated union fields - use exactly one

httpApiKey
http_api_key · object

One of the discriminated union fields - use exactly one

httpBasic
http_basic · object

One of the discriminated union fields - use exactly one

httpBearer
http_bearer · object

One of the discriminated union fields - use exactly one

iam
iam · object

One of the discriminated union fields - use exactly one

kubernetes
kubernetes · object

One of the discriminated union fields - use exactly one

snowflakeKey
snowflake_key · object

One of the discriminated union fields - use exactly one

sshKey
ssh_key · object

One of the discriminated union fields - use exactly one

Response

Success

nativeUser
native_user · object

Exactly one of these fields is required: basic or http_api_key or http_basic or http_bearer or iam or kubernetes or snowflake_key or ssh_key.