Skip to content
OTA-Pulse Docs

Create Api Key

POST
/api/api-keys

Create a new API key

Authorizations

Parameters

Query Parameters

organization_id
required
string format: uuid

Request Body required

Create API key

object
description
Any of:
string
expires_at
Any of:
string format: date-time
name
required
string
>= 1 characters <= 255 characters
scopes
Array<string>

Responses

201

Successful Response

Response when API key is created (includes full key)

object
created_at
required
string format: date-time
description
required
Any of:
string
expires_at
required
Any of:
string format: date-time
id
required
string format: uuid
is_active
required
boolean
key
required
string
key_prefix
required
string
last_used_at
required
Any of:
string format: date-time
name
required
string
organization_id
required
string format: uuid
scopes
required
Array<string>
user_id
required
Any of:
string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string