API Keys

Create an API key

Creates an API Gateway key for the team and attaches it to the usage plan that carries the rate limit. The plaintext key is in the value field of the response — but it is also retrievable later via GET /teams/{id}/keys, so it is not a show-once secret.

The caller must be a member of the team. A non-member gets HTTP 200 with {"message": "Not authorized to perform this operation"}, not a 403.

post/teams/{id}/keys

Request

  • Base URL: https://api.indexone.io
  • URL: https://api.indexone.io/teams/{id}/keys
  • Auth: API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Team id.

Response

The new key — or, if the caller is not a team member, {"message": "Not authorized to perform this operation"} with this same 200 status.

idstring

API Gateway key id — the value passed to DELETE /teams/{id}/keys/{key_id}.

valuestring

The key itself, in plaintext. Send it as the x-api-key header.

created_atstring date

YYYY-MM-DD.

enabledboolean

Example response

{
  "id": "k3n8qz1p42",
  "value": "8Kd0Wq3mZa7Yr1Xu5Tv9Bc2Ne6Lp4Hs0Gj8Fd3R",
  "created_at": "2026-03-11",
  "enabled": true
}

Changes

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