Get API base Url

Auth

Gets the API base Url configuration value.

Responses

The API base Url was successfully retrieved

application/json

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 is no configured API base value but optimistic locking was sent. (code: adminconsole.base_url.not_found)

application/json

The persisted Url is malformed. (code: adminconsole.base_url.invalid_persisted_data)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "${API_URL}/platform/configuration/api_base_url" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "value": "string"
}

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