It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« API - Base Url Set API base Url »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.11] ›RESTful API ›API reference ›API - Base Url

Get API base Url

edit

Get API base Url

edit

Gets the API base Url configuration value.

Request

edit

GET /api/v1/platform/configuration/api_base_url

Responses

edit
200

(ApiBaseUrlData) The API base Url was successfully retrieved

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
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

Request example

edit
curl -XGET https://{{hostname}}/api/v1/platform/configuration/api_base_url \
-H "Authorization: ApiKey $ECE_API_KEY"
« API - Base Url Set API base Url »