v47

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2024-10-01163166522.3 KB

ApiKeys

Create api_key

Create a new api_key. It is possible to have multiple API keys with the same name. There is no de-duplication

post/v1/api_key

Request body

namestring required

Name of the api key. Does not have to be unique

org_namestring nullable

For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the API key belongs in.

Response

Returns an object containing the raw API key. This is the only time the raw API key will be exposed

idstring uuid required

Unique identifier for the api key

createdstring date-time nullable

Date of api key creation

namestring required

Name of the api key

preview_namestring required

user_idstring uuid nullable

Unique identifier for the user

org_idstring uuid nullable

Unique identifier for the organization

keystring required

The raw API key. It will only be exposed this one time