Update Config Store Option

PUT /platform/configuration/store/{config_option_id}

Auth

Update existing Config Store Option.

Path parameters

config_option_id string required: Name of the Config Store Option that you would like to modify

Query parameters

version string: 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

The Config Store Option definition

value string required: Value of this Config Store Option

Responses

Config Store Option retrieved successfully

application/json

name string required: Name of this Config Store Option
value string required: Value of this Config Store Option
changed boolean required: Whether or not this Config Store Option has changed

Response headers

x-cloud-resource-version string: The resource version, which is used to avoid update conflicts with concurrent operations
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)

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

application/json

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

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PUT "${API_URL}/platform/configuration/store/${CONFIG_OPTION_ID}" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "string"
  }'

Generated from the API spec

Response

{
  "name": "string",
  "value": "string",
  "changed": false
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec