Update Config Store Option

edit

Update existing Config Store Option.

Request

edit

PUT /api/v1/platform/configuration/store/{config_option_id}

Path parameters

edit
Name Type Required Description

config_option_id

string

Y

Name of the Config Store Option that you would like to modify

Query parameters

edit
Name Type Required Description

version

string

N

If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Request body

edit

(ConfigStoreOptionData) (required) The Config Store Option definition

Responses

edit
200

(ConfigStoreOption) Config Store Option retrieved successfully

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
404

(BasicFailedReply) There was no existing data for the given Config Store Id. (code: platform.config.store.not_found)

Headers

x-cloud-error-codes (string; allowed values: [platform.config.store.not_found])
The error codes associated with the response
409

(BasicFailedReply) There is a version conflict. (code: platform.config.store.version_conflict)

Headers

x-cloud-error-codes (string; allowed values: [platform.config.store.version_conflict])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPUT https://{{hostname}}/api/v1/platform/configuration/store/{config_option_id} \
-H "Authorization: ApiKey $ECE_API_KEY" \
-d '
{
   "value" : "string"
}
'