Set API base Urledit

Saves the API base Url configuration value.

Requestedit

PUT /api/v1/platform/configuration/api_base_url

Query parametersedit

Name Type Required Description

skip_cascading_operations

boolean; default: false

N

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

version

string

N

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.

Request bodyedit

(ApiBaseUrlData) (required) Data containing the base Url to set

Responsesedit

200

(ApiBaseUrlData)

The API base Url was successfully saved.

Headers

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

(BasicFailedReply)

The optimistic locking version format was wrong. (code: adminconsole.base_url.bad_version_format)

Headers

x-cloud-error-codes (string; allowed values: [adminconsole.base_url.bad_version_format])
The error codes associated with the response
404

(BasicFailedReply)

There is no configured API base value but optimistic locking was sent. (code: adminconsole.base_url.not_found)

Headers

x-cloud-error-codes (string; allowed values: [adminconsole.base_url.not_found])
The error codes associated with the response
409

(BasicFailedReply)

There was an optimistic locking version conflict. (code: adminconsole.base_url.version_conflict)

Headers

x-cloud-error-codes (string; allowed values: [adminconsole.base_url.version_conflict])
The error codes associated with the response
412

(BasicFailedReply)

skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: security_deployment.cluster_pending_plan_exists)

Headers

x-cloud-error-codes (string; allowed values: [security_deployment.cluster_pending_plan_exists])
The error codes associated with the response

Request exampleedit

curl -XPUT https://{{hostname}}/api/v1/platform/configuration/api_base_url \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "value" : "string"
}
'