Get a Config Store Secret

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

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

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

Update Config Store Secret

Updates a secret for 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

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

Body

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

Delete Config Store Secret

Removes a secret from a Config Store.

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

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

ACLs

List all ACLs

List all ACLs

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

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

A successful response listing ACLs

dataarray[object]

Example:{"consumer":{"id":"84a73fb8-50fc-44a7-a4d5-aa17728ee83f"},"group":"foo","id":"b1f34145-0343-41a4-9602-4c69dec2f269"}

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/acls
 
application/json