Skip to content

Owner key management

Generate or rotate the API key

Issue a new key and return its full value once. If a key is already active, it stops working immediately.

POST/api/v1/organization/api-key/rotate
View examples

Authentication

Authorization required header

An access token from normal sign-in as the organization owner.

Set up access

Parameters

This operation takes no path or query parameters.

This operation takes no request body.

Responses

200Successful Response

application/jsonOrganizationAPIKeyIssued

  • configuredbooleanrequired
  • prefixstring | nullrequired
  • issued_atstring · date-time | nullrequired
  • api_keystringrequired
401Missing, invalid, expired, or revoked authentication credentials

application/jsonApiErrorOut

  • detailstring | array of ValidationIssueOut | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • codestring | null

WWW-Authenticate · Authentication challenge for the required credential scheme

403The authenticated account is not permitted to perform this operation

application/jsonApiErrorOut

  • detailstring | array of ValidationIssueOut | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • codestring | null
413Image or total request body exceeds its configured byte limit

application/jsonApiErrorOut

  • detailstring | array of ValidationIssueOut | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • codestring | null
500Unexpected server error; internal details are withheld

application/jsonApiErrorOut

  • detailstring | array of ValidationIssueOut | objectrequired
    Show fields
    • locarray of string | integerrequired
    • msgstringrequired
    • typestringrequired
  • codestring | null