List all config stores for 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

List of Config Stores

ListConfigStoresResponse

metaobjectrequired

Pagination metadata.

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

Create Config Store

Create a Config Store

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

Create Config Store Request

The request schema to create a Config Store.

* Additional properties are NOT allowed.
namestring

>= 1 characters<= 100 characters

Example:Config Store

Response

application/json

Config Store

ConfigStore

idstring(uuid)read-only

The Config Store ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestring

The name of the Config Store

Example:My Name

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}/config-stores

Body

{ "name": "Config Store" }
 
application/json

Get a Config Store

Returns a Config Store

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

configStoreIdstring(uuid)required

Config Store identifier

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

Response

application/json

Config Store

ConfigStore

idstring(uuid)read-only

The Config Store ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestring

The name of the Config Store

Example:My Name

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}/config-stores/{configStoreId}
 
application/json

Update an individual Config Store

Updates a Config Store

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

configStoreIdstring(uuid)required

Config Store identifier

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

Body

application/json

Update Config Store Request

The request schema to update a Config Store.

* Additional properties are NOT allowed.
namestring

>= 1 characters<= 100 characters

Example:Config Store

Response

application/json

Config Store

ConfigStore

idstring(uuid)read-only

The Config Store ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestring

The name of the Config Store

Example:My Name

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}/config-stores/{configStoreId}

Body

{ "name": "Config Store with Updated Name" }
 
application/json

Delete Config Store

Removes a config store

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

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}/config-stores/{configStoreId}