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 - Allocators Search allocators »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Platform - Allocators

Get allocators

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

Get allocators

edit

Retrieves the information for all of the allocators in the platform.

Request

edit

GET /api/v1/platform/infrastructure/allocators

Query parameters

edit
Name Type Required Description

q

string

N

(Optional) The query that filters the allocators. Maps to an Elasticsearch query_string query.

Responses

edit
200

(AllocatorOverview) The allocator information is retrieved.

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

Request example

edit
curl -XGET {{hostname}}/api/v1/platform/infrastructure/allocators \
-u $CLOUD_USER:$CLOUD_KEY
« Platform - Allocators Search allocators »