Get a Config Store Secret in a workspace

Returns the secret entity for the Config Store in a workspace. Secret values once stored cannot be retrieved.

get

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

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

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

configStoreIdstring(uuid)required

Config Store identifier

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

keystringrequired

Config Store Secret key

Example:ConfigStoreSecretKey

Response

application/json

Config Store Secret

ConfigStoreSecret

keystring
valuestring
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}/{workspace}/config-stores/{configStoreId}/secrets/{key}
 
application/json

Update Config Store Secret in a workspace

Updates a secret for a Config Store in a workspace.

put

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

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

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

configStoreIdstring(uuid)required

Config Store identifier

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

keystringrequired

Config Store Secret key

Example:ConfigStoreSecretKey

Body

application/json

UpdateConfigStoreSecret

valuestringrequired

>= 1 characters<= 5120 characters

Response

application/json

Config Store Secret

ConfigStoreSecret

keystring
valuestring
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}/{workspace}/config-stores/{configStoreId}/secrets/{key}

Body

{ "value": "ConfigStoreSecretValue" }
 
application/json

Delete Config Store Secret in a workspace

Removes a secret from a Config Store in a workspace.

delete

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

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

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

configStoreIdstring(uuid)required

Config Store identifier

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

keystringrequired

Config Store Secret key

Example:ConfigStoreSecretKey

Response

Secret for the Config Store was deleted successfully.

delete/control-planes/{controlPlaneId}/{workspace}/config-stores/{configStoreId}/secrets/{key}
 

Debug Sessions

Debug Sessions

List all debug sessions for a control plane

DEPRECATED
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

List of DebugSessions

ListDebugSessionsResponse

metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required
Show Child Parameters
get/control-planes/{controlPlaneId}/observability/debug-sessions
 
application/json