v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-065662751.8 MB

Keys

Upsert a Key

Create or Update Key using ID or name.

put/{workspace}/keys/{KeyIdOrName}

Path parameters

workspacestring required

Example:team-payments

The name of the workspace

Request body

created_atinteger nullable

Unix epoch when the resource was created.

idstring nullable

A string representing a UUID (universally unique identifier).

jwkstring nullable

A JSON Web Key represented as a string.

kidstring required

A unique identifier for a key.

namestring nullable

The name to associate with the given keys.

tagsstring[] nullable

An optional set of strings associated with the Key for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

x5tstring nullable

X.509 certificate SHA-1 thumbprint.

Example request

{
  "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  "jwk": "{\"alg\":\"RSA\",  \"kid\": \"42\",  ...}",
  "kid": "42",
  "name": "a-key",
  "pem": {
    "private_key": "-----BEGIN",
    "public_key": "-----BEGIN"
  },
  "set": {
    "id": "b86b331c-dcd0-4b3e-97ce-47c5a9543031"
  }
}

Response

Successfully upserted Key