Elastic Stack (ELK Stack) Platform Infrastructure API
The PlatformInfrastructure API from Elastic Stack (ELK Stack) — 51 operation(s) for platforminfrastructure.
Elastic Stack (ELK Stack) Platform Infrastructure API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PlatformInfrastructure. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 83 operations across 51 paths, and defines 130 schemas. It is described by OpenAPI 3.2.0, at version 1.
Requests are made against a single base URL, https://{{hostname}}/api/v1.
83 operations
51 paths
130 schemas
12 DELETE29 GET6 PATCH20 POST16 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Elastic Stack (ELK Stack) Platform Infrastructure API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKey).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 83
Across 51 paths, the API surfaces 83 operations — 12 DELETE, 29 GET, 6 PATCH, 20 POST, 16 PUT. Each is listed below with its method, path, parameters, and response codes.
PlatformInfrastructure 83
GET
/platform/configuration/api_base_url
Get API base Url
PUT
/platform/configuration/api_base_url
Set API base Url
GET
/platform/configuration/store
List Config Store Option
GET
/platform/configuration/store/{config_option_id}
Find Config Store Option by name
POST
/platform/configuration/store/{config_option_id}
Create Config Store Option
PUT
/platform/configuration/store/{config_option_id}
Update Config Store Option
DELETE
/platform/configuration/store/{config_option_id}
Delete Config Store Option by name
GET
/platform/infrastructure/adminconsoles
Get adminconsoles
POST
/platform/infrastructure/adminconsoles/_reindex
Reindex region indices
GET
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Get adminconsole logging settings
PUT
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Set adminconsole logging settings
DELETE
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Delete adminconsole logging settings
PATCH
/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings
Update adminconsole logging settings
GET
/platform/infrastructure/allocators
Get allocators
POST
/platform/infrastructure/allocators/_resync
Resynchronize allocators
POST
/platform/infrastructure/allocators/_search
Search allocators
GET
/platform/infrastructure/allocators/{allocator_id}
Get allocator
DELETE
/platform/infrastructure/allocators/{allocator_id}
Delete allocator
POST
/platform/infrastructure/allocators/{allocator_id}/_resync
Resynchronize allocator
POST
/platform/infrastructure/allocators/{allocator_id}/clusters/_move
Move clusters
POST
/platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move
Move clusters by type
GET
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Get allocator logging settings
PUT
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Set allocator logging settings
DELETE
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Delete allocator logging settings
PATCH
/platform/infrastructure/allocators/{allocator_id}/logging_settings
Update allocator logging settings
POST
/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start
Start maintenance mode
POST
/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_stop
Stop maintenance mode
GET
/platform/infrastructure/allocators/{allocator_id}/metadata
Get allocator metadata
PUT
/platform/infrastructure/allocators/{allocator_id}/metadata
Set allocator metadata
PUT
/platform/infrastructure/allocators/{allocator_id}/metadata/{key}
Set allocator metadata item
DELETE
/platform/infrastructure/allocators/{allocator_id}/metadata/{key}
Delete allocator metadata item
GET
/platform/infrastructure/allocators/{allocator_id}/settings
Get allocator settings
PUT
/platform/infrastructure/allocators/{allocator_id}/settings
Set allocator settings
PATCH
/platform/infrastructure/allocators/{allocator_id}/settings
Update allocator settings
GET
/platform/infrastructure/blueprinter/roles
List roles
POST
/platform/infrastructure/blueprinter/roles
Create a role
GET
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}
Get role
PUT
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}
Update role
DELETE
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}
Delete role
PUT
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings
Set blessings
PUT
/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings/{runner_id}
Add Blessing
GET
/platform/infrastructure/constructors
Get constructors
POST
/platform/infrastructure/constructors/_resync
Resynchronize constructors
GET
/platform/infrastructure/constructors/{constructor_id}
Get constructor
POST
/platform/infrastructure/constructors/{constructor_id}/_resync
Resynchronize constructor
GET
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Get constructor logging settings
PUT
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Set constructor logging settings
DELETE
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Delete constructor logging settings
PATCH
/platform/infrastructure/constructors/{constructor_id}/logging_settings
Update constructor logging settings
POST
/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start
Start maintenance mode
POST
/platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_stop
Stop maintenance mode
GET
/platform/infrastructure/coordinators
Get coordinators
GET
/platform/infrastructure/coordinators/candidates
Get coordinator candidates
GET
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}
Get a coordinator candidate
DELETE
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}
Delete coordinator candidate
POST
/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}/_promote
Promote a coordinator candidate
GET
/platform/infrastructure/coordinators/{coordinator_id}
Get a coordinator
POST
/platform/infrastructure/coordinators/{coordinator_id}/_demote
Demote a coordinator
GET
/platform/infrastructure/proxies
Get proxies
POST
/platform/infrastructure/proxies/filtered-groups
Create filtered group of proxies
GET
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}
Get filtered group of proxies
PUT
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}
Update filtered group of proxies
DELETE
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}
Delete filtered group of proxies
GET
/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health
Get health for a filtered group of proxies
GET
/platform/infrastructure/proxies/health
Get proxy health
GET
/platform/infrastructure/proxies/settings
Get proxies settings
PUT
/platform/infrastructure/proxies/settings
Set proxy settings
PATCH
/platform/infrastructure/proxies/settings
Update proxy settings
GET
/platform/infrastructure/proxies/{proxy_id}
Get proxy
GET
/platform/infrastructure/runners
Get runners
POST
/platform/infrastructure/runners/_resync
Resynchronize runners
POST
/platform/infrastructure/runners/_search
Search runners
GET
/platform/infrastructure/runners/{runner_id}
Get runner
DELETE
/platform/infrastructure/runners/{runner_id}
Delete runner
POST
/platform/infrastructure/runners/{runner_id}/_resync
Resynchronize runner
GET
/platform/infrastructure/runners/{runner_id}/logging_settings
Get runner logging settings
PUT
/platform/infrastructure/runners/{runner_id}/logging_settings
Set runner logging settings
DELETE
/platform/infrastructure/runners/{runner_id}/logging_settings
Delete runner logging settings
PATCH
/platform/infrastructure/runners/{runner_id}/logging_settings
Update runner logging settings
PUT
/platform/infrastructure/runners/{runner_id}/roles
Set runner roles
GET
/platform/license
Get license
PUT
/platform/license
Add or update license
DELETE
/platform/license
Delete license
Schemas 130
The contract defines 130 schemas that model the data the API accepts and returns. The most detailed are ElasticsearchPlanControlConfiguration (18 properties), LicenseInfo (16 properties), RunnerInfo (14 properties), AllocatorInfo (13 properties). Each schema is shown below with its type and property counts.
LicenseInfo
object
Information about a license.
16 properties
8 required
TransientEnterpriseSearchPlanConfiguration
object
Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied
2 properties
BoolQuery
object
A query for documents that match boolean combinations of other queries.
5 properties
LoggingSettings
object
Information about logging settings.
1 property
1 required
ProxyInfo
object
Information about a proxy.
8 properties
6 required
IndexSynchronizationResults
object
Results from synchronizing indices
4 properties
4 required
CoordinatorCandidatesSummary
object
Summarized information about coordinator candidates.
1 property
1 required
ExistsQuery
object
Matches documents that have at least one non-null value in the original field.
1 property
1 required
CoordinatorSummary
object
Summarized information about a coordinator.
6 properties
6 required
RestoreSnapshotConfiguration
object
Restores a snapshot from a local or remote repository.
6 properties
1 required
MoveKibanaClusterConfiguration
object
The configuration object for moving Kibana instances.
2 properties
1 required
AllocatorCapacityMemory
object
The available and used memory of the allocator.
2 properties
2 required
MoveEnterpriseSearchDetails
object
Information about the Elastic Enterprise Search that you want to move.
3 properties
1 required
EmptyResponse
object
AllocatedInstancePlansInfo
object
The plan information for the Elasticsearch cluster associated with the Kibana instance or APM Server.
3 properties
1 required
AdminconsolesOverview
object
Information about all of the adminconsoles.
1 property
1 required
AllocatorHealthChecks
object
The checks performed to determine if an allocator is healthy or not.
3 properties
3 required
ConfigStoreOption
object
Information about the Config Store options.
3 properties
3 required
ContainerConfigHostConfig
object
Docker host config
7 properties
4 required
MoveApmClusterConfiguration
object
The configuration object for moving APM Servers.
2 properties
1 required
AllocatedInstanceStatus
object
The status of the allocated Kibana instance or APM Server.
11 properties
4 required
CoordinatorsSummary
object
Summarized information about coordinators.
1 property
1 required
RoleAggregates
object
A list of Role aggregates
1 property
1 required
ApiBaseUrlData
object
Information about the API base Url
1 property
1 required
ZkAcl
object
Represents a Zookeeper ACL permission
3 properties
3 required
RunnerBuildInfo
object
2 properties
ProxyAllocationInfo
object
The single proxy allocation for a specified type, such as Elasticsearch, Kibana, or APM.
2 properties
2 required
RunnerInfo
object
Information about a specified runner.
14 properties
7 required
ConfigStoreOptionData
object
The data for the Config Store options.
1 property
1 required
ClusterLicenseInfo
object
Information about the Elasticsearch cluster license.
1 property
1 required
MoveClustersDetails
object
Information about the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers that are moved off of the allocator.
5 properties
5 required
TermQuery
object
A query for documents that contain the specified term in the inverted index.
1 property
1 required
QueryContainer
object
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
11 properties
AllocatorZoneInfo
object
The allocators for the specified zone.
2 properties
2 required
InstanceMoveRequest
object
The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction wit…
3 properties
1 required
AllocatorMoveRequest
object
As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.
3 properties
1 required
KibanaPlanControlConfiguration
object
The configuration settings for the timeout and fallback parameters.
10 properties
RollingGrowShrinkStrategyConfig
object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of…
AllocatorOverview
object
The overview information for the installed allocators.
1 property
1 required
RoleWithMeta
object
Persisted role along with metadata
2 properties
2 required
CoordinatorCandidateInfo
object
Summarized information about a coordinator candidate.
6 properties
5 required
GrowShrinkStrategyConfig
object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer…
ProxiesFilteredGroupHealth
object
The health status of a filtered proxy group.
3 properties
3 required
AllocatorBuildInfo
object
Information about the build that is running on the allocator.
2 properties
BasicFailedReplyElement
object
3 properties
2 required
LicenseObject
object
The container for a license.
2 properties
1 required
RunnerRoleInfo
object
Information about a runner role.
1 property
1 required
ContainersEntryOptionsACL
object
ZooKeeper ACL information.
3 properties
3 required
MoveEnterpriseSearchConfiguration
object
The configuration object for moving Elastic Enterprise Search instances.
2 properties
1 required
MoveElasticsearchClusterConfiguration
object
The configuration object for moving Elasticsearch clusters.
2 properties
1 required
ConstructorHealthStatus
object
The health status of the constructor.
2 properties
2 required
RunnerHealthChecks
object
The checks performed to determine if an runner is healthy or not.
3 properties
3 required
AutodetectStrategyConfig
object
A strategy that lets constructor choose the most optimal way to execute the plan.
ConstructorInfo
object
Information about the constructor.
2 properties
2 required
ExternalHyperlink
object
3 properties
2 required
TransientAppSearchPlanConfiguration
object
Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied
2 properties
RestoreSnapshotRepoConfiguration
object
Configures the location of a remote repository. The default is the system repository.
1 property
ProxiesFilteredGroup
object
A set of proxy filters with an expected number of matching proxies.
3 properties
2 required
ProxiesSettings
object
WARNING This object is deprecated and scheduled to be removed in the next major version.
4 properties
4 required
MatchAllQuery
object
A query that matches all documents.
RollingStrategyConfig
object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan ch…
4 properties
UsageStats
object
Information about the current usage.
1 property
1 required
ContainersEntryOptions
object
Options for a ContainersEntry belonging to a role
7 properties
3 required
SnapshotDependencyConfiguration
object
Configuration for attaching a snapshot repository dependency from another cluster. This creates a snapshot repository in the target cluster pointing to the sou…
1 property
1 required
AllocatorCapacity
object
The total and used capacity of the allocator.
4 properties
2 required
Role
object
Describes whether certain runners are blessed to run a Role.
3 properties
3 required
ElasticsearchPlanControlConfiguration
object
The configuration settings for the timeout and fallback parameters.
18 properties
AllocatorInfo
object
The overview information for the allocator.
13 properties
11 required
RoleAggregate
object
Describes whether certain runners are blessed to run a Role.
4 properties
2 required
ConstructorOverview
object
The overview information for the installed constructors.
1 property
1 required
ProxyAllocationCounts
object
The number of proxy allocations.
2 properties
2 required
RestartPolicy
object
A policy that is applied when a container unexpectedly exits
2 properties
1 required
TransientKibanaPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.
2 properties
RestoreSnapshotApiConfiguration
object
The configuration for the restore command, such as which indices you want to restore.
2 properties
MoveElasticsearchClusterDetails
object
Information about the Elasticsearch cluster that you want to move.
3 properties
1 required
SearchRequest
object
An Elasticsearch search request with a subset of options.
5 properties
ConfigStoreOptionList
object
A list of Config Store values.
1 property
1 required
EnterpriseSearchPlanControlConfiguration
object
10 properties
ProxiesAllocationsInfo
object
The allocation status for a specified type, such as Elasticsearch, Kibana, or APM. The status is part of the overall proxy health information.
3 properties
3 required
MoveKibanaClusterDetails
object
Information about the Kibana instance that you want to move.
3 properties
1 required
RemoteResources
object
The list of resources used as remote clusters
1 property
1 required
BlessingsWithMeta
object
Persisted Blessings along with metadata
2 properties
2 required
AppSearchPlanControlConfiguration
object
10 properties
PendingStatesWithMeta
object
Persisted pending states for a role along with metadata
2 properties
2 required
PendingStates
object
Describes whether certain runners are waiting to be blessed.
1 property
1 required
MetadataItems
object
The container object for metadata items.
1 property
1 required
AllocatorSettings
object
The settings for the allocator.
1 property
RunnerContainerInfo
object
Information about a container within a runner.
2 properties
2 required
MoveAppSearchDetails
object
Information about the App Search that you want to move.
3 properties
1 required
AllocatorHealthStatus
object
The health status of the allocator.
5 properties
3 required
ContainersEntryOptionsContainerConfig
object
Container config. Roughly corresponds to Docker container config
2 properties
1 required
MoveAppSearchConfiguration
object
The configuration object for moving App Searches.
2 properties
1 required
NestedQuery
object
A query that matches nested objects.
3 properties
2 required
PendingState
object
Pending state
1 property
1 required
RunnerRolesInfo
object
A list of runner roles.
1 property
1 required
MoveApmClusterDetails
object
Information about the APM Server that you want to move.
3 properties
1 required
RangeQuery
object
The query that matches documents with fields that contain terms within a specified range.
7 properties
Metadata
object
Metadata of an entity
3 properties
3 required
ContainersEntry
object
Represents the association between a Role and a Container Set
4 properties
4 required
RemoteResourceInfo
object
Information about a Remote Cluster.
5 properties
5 required
BasicFailedReply
object
1 property
1 required
MoveClustersCommandResponse
object
Information about the move operations for the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers, prior to the move.
2 properties
2 required
RemoteResourceRef
object
The Elasticsearch resource used as a Remote Cluster.
5 properties
3 required
PrefixQuery
object
The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.
2 properties
1 required
TransientApmPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
2 properties
ApmPlanControlConfiguration
object
The plan control configuration options for the APM Server.
10 properties
MatchQuery
object
Consumes and analyzes text, numbers, and dates, then constructs a query.
4 properties
1 required
MoveClustersRequest
object
The request for moving Elasticsearch clusters off an allocator.
5 properties
AdminconsoleInfo
object
Information for the adminconsole.
1 property
1 required
RoleAggregateCreateData
object
Creation data for a role
2 properties
1 required
ModelVersionIndexSynchronizationResults
object
Results from synchronizing indices by model version
1 property
1 required
RunnerOverview
object
Information about all of the runners.
1 property
1 required
PlanStrategy
object
The options for performing a plan change. Specify only one property each time. The default is growandshrink.
4 properties
ContainersEntryOptionsAuth
object
ZooKeeper Authentication information.
2 properties
2 required
MetadataItem
object
The key-value pair.
2 properties
2 required
QueryStringQuery
object
A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax.
5 properties
1 required
PortBinding
object
Value used to bind to a port on the host.
2 properties
1 required
AllocatorCapacityStorage
object
The storage capacity of the allocator.
1 property
1 required
ProxyOverview
object
Information about all of the proxies.
3 properties
3 required
ContainersEntryOptionsOverrides
object
Overrides for the container allocation.
1 property
ProxiesFilter
object
Selects proxies by matching a proxy metadata item.
2 properties
2 required
MatchNoneQuery
object
A query that doesn't match any documents.
ProxiesHealth
object
5 properties
5 required
Blessing
object
Whether something is blessed or not
1 property
1 required
TransientElasticsearchPlanConfiguration
object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
6 properties
ProxiesSSOSettings
object
WARNING This object is deprecated and scheduled to be removed in the next major version.
6 properties
6 required
SimpleQueryStringQuery
object
A query that uses simple query string syntax. Will ignore invalid syntax.
13 properties
1 required
Blessings
object
Describes whether certain runners are blessed to run a Role.
1 property
1 required
ProxiesHttpSettings
object
WARNING This object is deprecated and scheduled to be removed in the next major version.
6 properties
6 required
MetadataItemValue
object
The value of the metadata item, which is primarily used to add a single item when the key is provided in the URL.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Stack (ELK Stack) 12
Other APIs Elastic Stack (ELK Stack) publishes across the network.
Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
#PlatformInfrastructure
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Platform Infrastructure API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.