Set API base Url

PUT /platform/configuration/api_base_url

Saves the API base Url configuration value.

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). If not specified, will unconditionally upsert.
skip_cascading_operations boolean

Whether or not to skip cascading operations, such as re-provisioning the Security Deployment.

Default value is false.

Body Required

Data containing the base Url to set

value string Required

The configured base Url

Responses

200

The API base Url was successfully saved.
Hide headers attributes Show headers attributes
- 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)
Hide response attribute Show response attribute object
- value string Required
  
  The configured base Url
400

The optimistic locking version format was wrong. (code: adminconsole.base_url.bad_version_format)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is adminconsole.base_url.bad_version_format.
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
404

There is no configured API base value but optimistic locking was sent. (code: adminconsole.base_url.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is adminconsole.base_url.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
409

There was an optimistic locking version conflict. (code: adminconsole.base_url.version_conflict)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is adminconsole.base_url.version_conflict.
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
412

skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: security_deployment.cluster_pending_plan_exists)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is security_deployment.cluster_pending_plan_exists.
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

PUT /platform/configuration/api_base_url

curl \
 -X PUT https://{{hostname}}/api/v1/platform/configuration/api_base_url \
 -d '{"value":"string"}'

Request examples

{
  "value": "string"
}

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 (400)

# Headers
x-cloud-error-codes: adminconsole.base_url.bad_version_format

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

Response examples (404)

# Headers
x-cloud-error-codes: adminconsole.base_url.not_found

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

Response examples (409)

# Headers
x-cloud-error-codes: adminconsole.base_url.version_conflict

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

Response examples (412)

# Headers
x-cloud-error-codes: security_deployment.cluster_pending_plan_exists

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