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.

« Delete allocator Resynchronize allocator »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.10] ›RESTful API ›API reference ›Platform - Allocators

Get allocator

edit

Get allocator

edit

Retrieves the allocator by the ID.

Request

edit

GET /api/v1/platform/infrastructure/allocators/{allocator_id}

Path parameters

edit
Name Type Required Description

allocator_id

string

Y

The allocator identifier.

Responses

edit
200

(AllocatorInfo) The information for the allocator specified by {allocator_id}

404

(BasicFailedReply) The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

Headers

x-cloud-error-codes (string; allowed values: [allocators.allocator_not_found])
The error codes associated with the response

Request example

edit
curl -XGET https://{{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Delete allocator Resynchronize allocator »