Skip to main content
PATCH
Update API key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
string
required

Management API version.

Path Parameters

id
string
required

Body

application/json
name
string

Name of an API key.

Required string length: 3 - 255
description
string

Description for an API key.

Required string length: 3 - 255
status
enum<string>

Set API key status. Use to enable or disable an API key.

Available options:
enabled,
disabled
rate_limit
number

Set rate limit for an API key. Value is in request-per-second.

Required range: x >= 0.1

Response

Updated API key object.

data
object
required