Updates a single API key. You can update the keys name, description, status, and rate limit. You cannot mutate the actual key itself.

Path Params
string
required
Body Params
string
length between 3 and 255

Name of an API key.

string
length between 3 and 255

Description for an API key.

string

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

number
≥ 0.1

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

Headers
string
required

Management API version.

Responses

Response body
object
data
object
required
string
required

Auto-generated ID for an API key

string
required

API key name

string

API key description

string
required

API key status, indicates if an API keys is enabled or disabled.

enabled disabled

string
required

ID of an environment the API key belongs to.

string
required

Type of an API key.

public secret proxy

string

Value of an API key. This field is immutable, and for secret keys it's only visible upon creation.

number
required

Current limit in requests-per-second for the API key.

date-time
required

Date when API key was created.

date-time

Date when API key was disabled.

Language
Credentials