Skip to main content
PATCH
/
encryption-keys
/
{id}
Update encryption key
curl --request PATCH \
  --url https://management-api.fpjs.io/encryption-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"
}
'
{
  "data": {
    "id": "tok_No3jUysGLCDuqB3RnCVf1weo",
    "name": "My Encryption Key",
    "status": "enabled",
    "environment": "ae_rrETjdWcfqI6AFsk",
    "created_at": "2024-05-31T01:24:39.506Z",
    "last_activated_at": "2024-05-31T01:24:39.506Z",
    "last_rotated_at": "2024-05-31T01:24:39.506Z",
    "description": "Description for my encryption key",
    "previous_token": "eWDrrpGGLjDQW0LBA0Wj",
    "token": "eWDrrpGGLjDQW0LBA0Wj",
    "next_token": "eWDrrpGGLjDQW0LBA0Wj",
    "last_deactivated_at": 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

Set encryption key name.

​
description
string

Set encryption key description.

​
status
enum<string>

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

Available options:
enabled,
disabled

Response

Updated encryption key object.

​
data
object
required