API Keys

Create a new API key

Generate a new API key. The plain-text token is returned once, in this response, and cannot be retrieved again.

post/api-keys

Request

  • Base URL
    https://statusstack.com/api
  • Auth
    HTTP bearer

Request body

namestring required

Descriptive name for the API key

versionstring

API version the key targets, v followed by a number.

permissionsstring[]

read, write and delete are open to every user. admin, platform-admin and * can only be granted by a super admin; anyone else gets a 422.

expires_in_daysinteger nullable

Days until the key expires. Omit or send null for a key that never expires.

team_idstring uuid nullable

Team the key is scoped to; the user must be a member. Omitted or null, the key is scoped to the user's current team.

organization_idstring uuid nullable

Organization the key is scoped to; the user must belong to it and the team must be in it. Omitted, it is the team's organization.

Response

API key created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.