ACLs3

Add-Ons4

API4

API Documentation4

API Implementation3

API Product Documentation4

API Product Version Specification4

API Product Versions4

API Products4

API Publication3

API Specification4

API Version4

API-keys3

App Auth Strategies4

Application Registrations4

Applications4

Assets4

Audit Logs7

Auth Server4

Auth Server Claims4

Auth Server Clients8

Auth Server Scopes4

Auth Settings9

Basic-auth credentials3

CA Certificates4

Catalog Services4

Centrally Managed Consumers4

Centrally Managed Keys3

Certificates4

Cloned Plugins4

CMEK3

Config Store Secrets4

Config Stores4

Consumer Groups6

Consumers4

Control Plane Groups2

Control Planes6

Custom Domains3

Custom Plugin Schemas4

CustomPlugins4

Data-Plane Group Configurations2

DCR Providers4

DP Certificates4

Event Gateway Backend Clusters4

Event Gateway DataPlane Certificates4

Event Gateway Listener Policies8

Event Gateway Listeners4

Event Gateway Schema Registries4

Event Gateway Static Keys3

Event Gateway TLS Trust Bundles4

Event Gateway Virtual Cluster Consume Policies20

Event Gateway Virtual Cluster Policies4

Event Gateway Virtual Cluster Produce Policies16

Event Gateway Virtual Clusters4

Event Gateways4

GraphQL Cost Decorations1

HMAC-auth credentials3

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances4

JWTs3

Keys4

KeySets4

Mesh5

MTLS-auth credentials3

Networks5

Pages4

Partials4

Personal Access Tokens2

Platform IPs1

Plugins449

Portal Appearance2

Portal Audit Logs3

Portal Auth Settings9

Portal Custom Domains4

Portal Customization2

Portal Developers4

Portal Product Versions3

Portal Team Roles2

Portal Teams4

Portals10

Portals IP Allow List4

Private DNS3

Provider Accounts1

Realms4

Roles6

Routes8

Serverless Cloud Gateways3

Services4

Snippets4

SNIs4

System Accounts5

System Accounts - Access Tokens4

System Accounts - Roles3

System Accounts - Team Membership2

Targets3

Team Membership2

Teams5

Transit Gateways4

Upstreams4

Vaults4

patchReset Auth Settings

Keys

Create a new Key

Create a new Key

post/v2/control-planes/{controlPlaneId}/core-entities/keys

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 created 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

Aug 22, 202596118a9cd7f422See the full diff
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / 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
Jul 22, 20252c77aeaee5fb11See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
Apr 15, 2025fc6abbc537f328See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request optional property became not read-only
  request-optional-property-became-not-read-only
- ○
  the request optional property became not read-only
  request-optional-property-became-not-read-only
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  the response optional property became not read-only for the status
  response-optional-property-became-not-read-only
- ○
  the response optional property became not read-only for the status
  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
Dec 6, 20244266633316551See the full diff
- ▲
  the request property became not nullable
  request-property-became-not-nullable
Nov 11, 202408ead66e9ebb79See the full diff
- ▲
  the request property became required
  request-property-became-required
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ○
  the request optional property became not read-only
  request-optional-property-became-not-read-only
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the response optional property became not read-only for the status
  response-optional-property-became-not-read-only
- ○
  the response property became required for the status
  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