Create an API key

POST/org/api_keys

Create a new API key within the authenticated organization.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Label for the API key (1-255 characters). API keys are not addressable by name.

Length1 <= length <= 255

days_to_expire?integer

Number of days until expiry, up to 3650. Use null for never.

Range1 <= value <= 3650

project_id?string

Unique project identifier

Response

application/json

API key created successfully

API key returned immediately after creation. Includes the plaintext key once.

id*string

Unique API key identifier

name*string

Label for the API key. API keys are not addressable by name; use the ID or key identifier for stable references.

created_at*string

When the API key was created

Formatdate-time

created_by*

expires_at*string

When the API key expires

Formatdate-time

deleted_at*string

When the API key was deleted (soft-deleted). Null for keys that have not been deleted.

Formatdate-time

project_id*string

Project identifier for project-scoped API keys. Null means org-wide.

project_name*string

Project name for project-scoped API keys. Null means the key is org-wide or the project name is unavailable.

masked_key*string

Masked version of the API key

key*string

Plaintext API key. Only returned once when the key is created.

curl -X POST "https://example.com/org/api_keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "string",  "name": "string",  "created_at": "2019-08-24T14:15:22Z",  "created_by": {    "id": "string",    "email": "user@example.com",    "name": "string"  },  "expires_at": "2019-08-24T14:15:22Z",  "deleted_at": "2019-08-24T14:15:22Z",  "project_id": "string",  "project_name": "string",  "masked_key": "string",  "key": "string"}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}