Delete Config Store in a workspace

Removes a Config Store in a workspace.

delete

Query Parameters

forcestring

If true, delete specified config store and all secrets, even if there are secrets linked to the config store. If false, do not allow deletion if there are secrets linked to the config store.

Allowed values:truefalse

Default:false

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

Response

Config Store was deleted successfully.

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

Config Store Secrets

Config Store Secrets

Create Config Store Secret in a workspace

Creates a secret for a Config Store in a workspace.

post

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

Body

application/json

CreateConfigStoreSecret

keystringrequired

>= 1 characters<= 512 characters

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

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

Body

{ "key": "ConfigStoreSecretKey", "value": "ConfigStoreSecretValue" }
 
application/json

List Config Store Secrets in a workspace

Returns a collection of all secrets for a Config Store in a workspace.

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

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

Response

application/json

List of Config Store Secrets

ListConfigStoreSecretsResponse

metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required
Show Child Parameters
get/control-planes/{controlPlaneId}/{workspace}/config-stores/{configStoreId}/secrets
 
application/json

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