Skip to main content
POST
Unarchive client key

Authorizations

Authorization
string
header
required

Path Parameters

key_id
string
required

Response

Successful response

Stored generic client key definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.

algorithm
enum<string>
required

Cryptographic or integration algorithm. Discriminator for polymorphic create, update, and response schemas.

Available options:
A128KW
component_ids
string[]
required
component_references
object[]
required
created_at
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

description
required

Optional build-time expression that resolves to a human-readable description.

id
string
required
read-only

Stable Extole identifier for the client key.

key
string
required

Key material in the same encoding accepted on create. Symmetric secrets and private keys are partially masked in API responses; public keys are returned in full PEM form.

name
required

Display name for the key, in the same build-time evaluatable form that was supplied on create or update.

partner_key_id
string
required

External key identifier used to match tokens or credentials to this key (for example the JWT kid header).

tags
string[]
required

Free-form tags applied to the client key.

type
enum<string>
required

Usage category that determines how the key is consumed at runtime.

Available options:
JWT,
PASSWORD,
PGP,
PGP_EXTOLE,
SSH,
WEBHOOK
updated_at
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"