Skip to content
OTA-Pulse Docs

Rotate Api Key

POST
/api/api-keys/{key_id}/rotate

Rotate an API key (revoke old, create new with same settings)

Authorizations

Parameters

Path Parameters

key_id
required
string format: uuid

Query Parameters

organization_id
required
string format: uuid

Responses

200

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