Skip to main content
POST
Create Key

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <access_token>. This must be an account API access token minted via a supported Parallel OAuth grant, not a standard API key. See the account API docs.

Path Parameters

app_id
string<uuid>
required

Body

application/json

Model for create API key request V2.

api_key_name
string
required

API Key Name

is_service_scoped
boolean
default:false

Create a service key, owned by the org and survives its creator leaving. Admins only

Response

Successful Response

Flattened response for the service create-key endpoint.

api_key_id
string
required

API Key ID

api_key_name
string
required

API Key Name

app_id
string
required

App ID

app_name
string
required

App Name

created_by_user_id
string
required

Created by User ID

created_by_user_email
string
required

Created by User Email

display_value
string
required

Display Value

created_at
integer
required

Created At

is_service_scoped
boolean
required

Service key, owned by the org and survives its creator leaving. False: a user key, revoked when its creator leaves the org