Find Config Store Option by name

GET /platform/configuration/store/{config_option_id}

Find Config Store Option by name.

Path parameters

  • config_option_id string Required

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

Responses

  • Config Store Option retrieved successfully

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • 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

  • Config Store Option do not exist by that name. (code: platform.config.store.not_found)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is platform.config.store.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /platform/configuration/store/{config_option_id}
curl \
 -X GET https://{{hostname}}/api/v1/platform/configuration/store/{config_option_id}
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "name": "string",
  "value": "string",
  "changed": true
}
Response examples (404)
# Headers
x-cloud-error-codes: platform.config.store.not_found

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