---
title: "Upsert a Key"
method: PUT
path: "/v2/control-planes/{controlPlaneId}/core-entities/keys/{KeyId}"
tags: ["Keys"]
---

# Upsert a Key

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

Create or Update Key using ID or name.

## Request body

- Key — A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `jwk` string, nullable — A JSON Web Key represented as a string.
  - `kid` string, required — A unique identifier for a key.
  - `name` string, nullable — The name to associate with the given keys.
  - `pem` object, nullable — A keypair in PEM format.
    - `private_key` string, nullable
    - `public_key` string, nullable
  - `set` object, nullable — The id (an UUID) of the key-set with which to associate the key.
    - `id` string
  - `tags` string[], nullable — An optional set of strings associated with the Key for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `x5t` string, nullable — X.509 certificate SHA-1 thumbprint.

## Response `200`

Successfully upserted Key

- Key — A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `jwk` string, nullable — A JSON Web Key represented as a string.
  - `kid` string, required — A unique identifier for a key.
  - `name` string, nullable — The name to associate with the given keys.
  - `pem` object, nullable — A keypair in PEM format.
    - `private_key` string, nullable
    - `public_key` string, nullable
  - `set` object, nullable — The id (an UUID) of the key-set with which to associate the key.
    - `id` string
  - `tags` string[], nullable — An optional set of strings associated with the Key for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `x5t` string, nullable — X.509 certificate SHA-1 thumbprint.

## Other responses

- `401` — Unauthorized

## Changes

- **2025-08-22** `96118a9cd7f4` — 2 breaking, 2 info
  - the response property `pem/private_key` became nullable for the status `200`
  - the response property `pem/public_key` became nullable for the status `200`
  - the request property `pem/private_key` became nullable
  - the request property `pem/public_key` became nullable
- **2025-07-22** `2c77aeaee5fb` — 1 breaking, 1 info
  - the response property `tags` became nullable for the status `200`
  - the request property `tags` became nullable
- **2025-04-15** `fc6abbc537f3` — 2 breaking, 8 info
  - the response property `created_at` became nullable for the status `200`
  - the response property `updated_at` became nullable for the status `200`
  - added the new optional request property `x5t`
  - the request optional property `created_at` became not read-only
  - …6 more
- **2024-12-06** `426663331655` — 1 breaking
  - the request property `tags` became not nullable
- **2024-11-11** `08ead66e9ebb` — 7 breaking, 9 info
  - the request property `kid` became required
  - the response property `id` became nullable for the status `200`
  - the response property `jwk` became nullable for the status `200`
  - the response property `name` became nullable for the status `200`
  - …12 more

[Change history](https://skmtc.dev/kong/apis/konnect-api/changes/v2/control-planes/:controlPlaneId/core-entities/keys/:KeyId/put.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/konnect-api/revisions/72502a676a92/schema)