Api Keys

Create API key

Changed on

Creates a new API key. The plaintext key is server-generated and returned in the raw_key field of the response — this is the ONLY time the plaintext is available. Store it securely client-side; it cannot be retrieved later.

To rotate a key: delete the old one and create a new one.

post/api/api-keys

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/api-keys
  • Auth: none required

Request body

namestring required
role_idstring uuid required
tenant_idstring uuid required

Example request

{
  "name": "",
  "role_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
}

Changes