Get default Deployment Domain Name

GET /platform/configuration/networking/deployment_domain_name

Gets the default Deployment Domain Name configuration value.

Responses

  • The Deployment Domain Name was successfully retrieved

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object
    • value string Required

      The domain name for all deployments. The hostname of an application in a deployment is constructed from the application ID and the domain name (for example, 1234567890.example.com).

  • There is no configured Deployment Domain Name but optimistic locking was sent. (code: networking.cname.not_found)

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

      Value is networking.cname.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/networking/deployment_domain_name
curl \
 -X GET https://{{hostname}}/api/v1/platform/configuration/networking/deployment_domain_name
Response examples (200)
# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
{
  "value": "string"
}
Response examples (404)
# Headers
x-cloud-error-codes: networking.cname.not_found

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