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.

« Platform - Configuration - Instances - CRUD Create instance configuration »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.7] ›RESTful API ›API reference ›Platform - Configuration - Instances - CRUD

Get instance configurations

edit

Get instance configurations

edit

Get instance configurations.

Request

edit

GET /api/v1/platform/configuration/instances

Query parameters

edit
Name Type Required Description

show_deleted

boolean

N

If true, instance configurations marked for deletions are also returned. Otherwise, only instance configurations not marked for deletion are returned

Responses

edit
200

(array[InstanceConfiguration]) A InstanceConfiguration

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XGET https://{{hostname}}/api/v1/platform/configuration/instances \
-H "Authorization: ApiKey $ECE_API_KEY"
« Platform - Configuration - Instances - CRUD Create instance configuration »