Get API base Urledit
Gets the API base Url configuration value.
Requestedit
GET /api/v1/platform/configuration/api_base_url
Responsesedit
-
200 -
(
ApiBaseUrlData) The API base Url was successfully retrievedHeaders
-
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
-
-
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
-
-
500 -
(
BasicFailedReply) The persisted Url is malformed. (code:adminconsole.base_url.invalid_persisted_data)Headers
-
x-cloud-error-codes(string; allowed values: [adminconsole.base_url.invalid_persisted_data]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XGET https://{{hostname}}/api/v1/platform/configuration/api_base_url \
-H "Authorization: ApiKey $ECE_API_KEY"