Skip to main content
GET
/
encryption-keys
List encryption keys
curl --request GET \
  --url https://management-api.fpjs.io/encryption-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Version: <x-api-version>'
{
  "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
    }
  ],
  "metadata": {
    "pagination": {
      "next_cursor": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI",
      "prev_cursor": 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.

Query Parameters

​
status
enum<string>

Filters by encryption key status.

Available options:
enabled,
disabled
​
environment
string

Filters by environment ID.

​
cursor
string

Cursor token used for pagination. Response will contain items appearing after the given cursor.

​
limit
number
default:10

Sets the maximum number of items contained in a single page.

Required range: 0 <= x <= 101

Response

List of encryption keys matching the given query.

​
data
object[]
required
​
metadata
object
required