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

Get allocators

edit

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

from

integer

N

(Optional) The offset from the first result you want to fetch. Defaults to 0.

q

string

N

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

size

integer

N

(Optional) The maximum number of search results to return. Defaults to 100.

sort

string

N

(Optional) An comma-separated array of fields to sort the search results by. Defaults to allocator_id.

Responses

edit
200

(AllocatorOverview) An overview of all allocators

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/infrastructure/allocators \
-H "Authorization: ApiKey $ECE_API_KEY"
« Platform - Allocators Resynchronize allocators »