Sign in

v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-065662751.8 MB
API-keys

Create a new API-key associated with a Consumer

Create a new API-key associated with a Consumer

post/{workspace}/consumers/{ConsumerIdForNestedEntities}/key-auth

Path parameters

ConsumerIdForNestedEntitiesstring required

Consumer ID for nested entities

workspacestring required
Example:team-payments

The name of the workspace

Request body

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

keystring nullable
tagsstring[] nullable

A set of strings representing tags.

ttlinteger nullable

key-auth ttl in seconds

Example request

{
  "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Response

Successfully created API-key

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

keystring nullable
tagsstring[] nullable

A set of strings representing tags.

ttlinteger nullable

key-auth ttl in seconds

Example response

{
  "consumer": {
    "id": "84a73fb8-50fc-44a7-a4d5-aa17728ee83f"
  },
  "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}