Skip to main content
PATCH
/
api-keys
/
{id}
Update API key
curl --request PATCH \
  --url https://management-api.fpjs.io/api-keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status": "enabled",
  "rate_limit": 1.1
}
'
{
  "data": {
    "id": "tok_No3jUysGLCDuqB3RnCVf1weo",
    "name": "My Public Key",
    "status": "enabled",
    "environment": "ae_rrETjdWcfqI6AFsk",
    "type": "public",
    "rateLimit": 5,
    "createdAt": "2024-05-31T01:24:39.506Z",
    "description": "Description for my public key",
    "token": "eWDrrpGGLjDQW0LBA0Wj",
    "disabledAt": null
  }
}

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