Create or update a node

Create or update a node.

put

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

nodeIdstring(uuid)required

Node identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Upsert Node Request

The request schema to upsert a Node.

* Additional properties are NOT allowed.
hostnamestring

Example:node1.my.domain.com

typestring

Example:knep

versionstring

Example:1.0

config_versionstring
errorsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Example response

itemobject
Show Child Parameters
put/control-planes/{controlPlaneId}/nodes/{nodeId}

Body

{}
 
application/json

Create or Update the declarative config

Create or Update the declarative config

put

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

DeclarativeConfig

configstring

The configuration as string. Must be valid yaml or json.

Response

application/json

Declarative Config Response

DeclarativeConfig

configstring

The configuration as string. Must be valid yaml or json.

versionstring(uuid)read-only

An uuid identifier (v7) of the version of the config payload.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/control-planes/{controlPlaneId}/declarative-config

Body

{}
 
application/json

Get the declarative configuration

Returns the declarative configuration set for the 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

Response

200 application/json

Declarative Config Response

DeclarativeConfig

configstring

The configuration as string. Must be valid yaml or json.

versionstring(uuid)read-only

An uuid identifier (v7) of the version of the config payload.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/control-planes/{controlPlaneId}/declarative-config
 
200 application/json

Delete the declarative config

Delete the declarative config

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

Response

The configuration was deleted successfully.

delete/control-planes/{controlPlaneId}/declarative-config
 

Get Event Proxy Configuration

Returns the declarative configuration formatted for a native event proxy.

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

Response

200 application/json

Declarative Config native event proxy Response

DeclarativeConfigNativeEventProxy

configobject

The configuration as JSON for the native event proxy.

versionstring(uuid)read-only

An uuid identifier (v7) of the version of the config payload.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/control-planes/{controlPlaneId}/declarative-config/native-event-proxy
 
200 application/json