Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

server_id
string
required

Body

application/json
name
string | null
Required string length: 1 - 255
auth_type
enum<string>
Available options:
bearer,
authorization,
headers,
none,
oauth
bearer_token
string
Required string length: 1 - 8192
authorization
string
Required string length: 1 - 8192
headers
object
expires_at
string<date-time> | null

Response

201 - application/json

OK

id
string
required
object
any
required
server_id
string
required
name
string | null
required
auth_type
enum<string>
required

oauth credentials come only from the OAuth connect flow.

Available options:
bearer,
authorization,
headers,
none,
oauth
authorization_preview
string | null
required
header_names
string[]
required
status
enum<string>
required

needs_reauthorization when the OAuth provider no longer honors the credential.

Available options:
active,
needs_reauthorization
scopes
string[] | null
required

Scopes granted to an oauth credential; null for every other auth_type.

expires_at
string<date-time> | null
required
last_used_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
revoked_at
string<date-time> | null
required