Sign in
API Keys

post/api-keys

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/api-keys
  • Auth: HTTP bearer

Request body

expires_atstring date-time nullable
namestring required
permissionsstring[] nullable
role_typestring required

Example request

{
  "expires_at": "2024-12-31T23:59:59Z",
  "permissions": [
    "projects:read",
    "deployments:read"
  ],
  "role_type": "admin"
}

Response

API key created successfully

api_keystring required
created_atstring date-time required
expires_atstring date-time nullable
idinteger required
key_prefixstring required
namestring required
permissionsstring[] nullable
role_typestring required

Example response

{
  "created_at": "2024-01-01T00:00:00Z",
  "expires_at": "2024-12-31T23:59:59Z"
}

Changes

No recorded changes to this operation across all 53 revisions of this API.