IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Platform - Configuration - Instances - CRUD Create instance configuration »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Platform - Configuration - Instances - CRUD

Get instance configurations

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

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

show_max_zones

boolean; default: false

N

If true, will populate the max_zones field of the instance configurations.

Responses

edit
200

(array[InstanceConfiguration])

A InstanceConfiguration

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 »