Pin New DP Client Certificate

Pin a new DP Client Certificate to this control plane. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this control plane.

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Request body for creating a dp-client-certificate.

certstringrequired

JSON escaped string of the certificate.

Response

application/json

Response body for retrieving a dp-client-certificate.

itemobject
Show Child Parameters
post/control-planes/{controlPlaneId}/dp-client-certificates

Body

{ "cert": "-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n" }
 
application/json

Get a DP Client Certificate

Retrieve a pinned dataplane client certificate associated to this control plane. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this control plane.

get

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

certificateIdstringrequired

Response

application/json

Response body for retrieving a dp-client-certificate.

itemobject
Show Child Parameters
get/control-planes/{controlPlaneId}/dp-client-certificates/{certificateId}
 
application/json

Delete DP Client Certificate

Remove a pinned dataplane client certificate associated to this control plane. Removing a pinned dataplane certificate would invalidate any dataplanes currently connected to this control plane using this certificate.

delete

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

certificateIdstringrequired

Response

No Content

delete/control-planes/{controlPlaneId}/dp-client-certificates/{certificateId}
 

Custom Plugin Schemas

Custom Plugin Schemas

List Custom Plugin Schemas

Returns an array of custom plugins schemas associated with a control plane.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A paginated list response for a collection of custom plugin schemas.

itemsarray[object]
Show Child Parameters
pageobject
Show Child Parameters
get/control-planes/{controlPlaneId}/core-entities/plugin-schemas
 
application/json