Sign in
Keys

Upsert a Key

Create or Update Key using ID or name.

put/v2/control-planes/{controlPlaneId}/core-entities/keys/{KeyId}

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

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 response

{
  "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"
  }
}

Changes

Changed in 5 of the 52 revisions of this API.1320

  • 96118a9cd7f422See the full diff
    • ▲

      the response property pem/private_key became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property pem/public_key became nullable for the status 200

      response-property-became-nullable

    • ○

      the request property pem/private_key became nullable

      request-property-became-nullable

    • ○

      the request property pem/public_key became nullable

      request-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2c77aeaee5fb11See the full diff
    • ▲

      the response property tags became nullable for the status 200

      response-property-became-nullable

    • ○

      the request property tags became nullable

      request-property-became-nullable

  • fc6abbc537f328See the full diff
    • ▲

      the response property created_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property updated_at became nullable for the status 200

      response-property-became-nullable

    • ○

      added the new optional request property x5t

      new-optional-request-property

    • ○

      the request optional property created_at became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request optional property updated_at became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request property created_at became nullable

      request-property-became-nullable

    • ○

      the request property updated_at became nullable

      request-property-became-nullable

    • ○

      added the optional property x5t to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property created_at became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property updated_at became not read-only for the status 200

      response-optional-property-became-not-read-only

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4266633316551See the full diff
    • ▲

      the request property tags became not nullable

      request-property-became-not-nullable

  • 08ead66e9ebb79See the full diff
    • ▲

      the request property kid became required

      request-property-became-required

    • ▲

      the response property id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property jwk became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property pem became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property set became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tags became nullable for the status 200

      response-property-became-nullable

    • ○

      the request optional property id became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request property id became nullable

      request-property-became-nullable

    • ○

      the request property jwk became nullable

      request-property-became-nullable

    • ○

      the request property name became nullable

      request-property-became-nullable

    • ○

      the request property pem became nullable

      request-property-became-nullable

    • ○

      the request property set became nullable

      request-property-became-nullable

    • ○

      the request property tags became nullable

      request-property-became-nullable

    • ○

      the response optional property id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response property kid became required for the status 200

      response-property-became-required

    This revision also has 88 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog