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

Get HTTP Proxy Configuration

Returns the declarative configuration formatted for an http gateway.

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/x-yaml

Declarative Config HTTP Gateway Response

DeclarativeConfigHTTPGateway

listenerobject
Show Child Parameters
routesarray[object]
Show Child Parameters
get/control-planes/{controlPlaneId}/declarative-config/http-gateway
 
200 application/x-yaml

Get Houdini Event Gateway Configuration

Returns the declarative configuration formatted for the event gateway.

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/x-yaml

Declarative Config Houdini Event Gateway Response

DeclarativeConfigHoudiniEventGateway

DeclarativeConfigHoudiniEventGatewayobject
get/control-planes/{controlPlaneId}/declarative-config/houdini-event-gateway
 
200 application/x-yaml