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.

« Set allocator metadata item Update allocator settings »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.9] ›RESTful API ›API reference ›Platform - Allocators

Get allocator settings

edit

Get allocator settings

edit

Retrieves the allocator override settings.

Request

edit

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

Path parameters

edit
Name Type Required Description

allocator_id

string

Y

The allocator identifier.

Responses

edit
200

(AllocatorSettings) Returns the settings for the specified Allocator

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The resource version, which is used to avoid update conflicts with concurrent operations
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}/settings \
-H "Authorization: ApiKey $ECE_API_KEY"
« Set allocator metadata item Update allocator settings »