How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) Platform API

The Platform API from Elastic Stack (ELK Stack) — 3 operation(s) for platform.

Elastic Stack (ELK Stack) Platform 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 Platform. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://{{hostname}}/api/v1.

5 operations 3 paths 25 schemas 1 DELETE3 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://{elasticsearch_endpoint}
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) Platform 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 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Platform 5
GET
/platform
Get platform info
get-platform → 200
GET
/platform/configuration/security/extra_certs
List extra certificates
get-extra-certificates → 200
GET
/platform/configuration/security/extra_certs/{cert_id}
Read extra certificate
get-extra-certificate 1 param → 200404
PUT
/platform/configuration/security/extra_certs/{cert_id}
Update extra certificate
set-extra-certificate 1 param body → 200400
DELETE
/platform/configuration/security/extra_certs/{cert_id}
Delete extra certificate
delete-extra-certificate 1 param → 200404

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are AllocatorsZoneSummary (9 properties), RegionInfo (9 properties), ContainerSetSummary (7 properties), RunnersSummary (7 properties). Each schema is shown below with its type and property counts.

ConstructorOverview
object
The overview information for the installed constructors.
1 property 1 required
AllocatorsZoneSummary
object
Summary of the allocators for the specified zone.
9 properties 9 required
PlatformInfo
object
Information about the platform.
6 properties 6 required
ZookeeperSummary
object
Information about the ZooKeeper state.
1 property 1 required
BasicFailedReplyElement
object
3 properties 2 required
ProxiesSummary
object
Summarized information about proxies.
4 properties 4 required
PlatformResourcesSummary
object
Information about resources.
6 properties 6 required
CoordinatorSummary
object
Summarized information about a coordinator.
6 properties 6 required
ConstructorHealthStatus
object
The health status of the constructor.
2 properties 2 required
UnreachableRegionInfo
object
Information about an unreachable region.
1 property 1 required
ConstructorInfo
object
Information about the constructor.
2 properties 2 required
AllocatorsSummary
object
Summarized information about allocators.
2 properties 2 required
EmptyResponse
object
RunnersSummary
object
Summarized information about the runners.
7 properties 7 required
RegionInfo
object
Information about a region.
9 properties 9 required
CoordinatorsSummary
object
Summarized information about coordinators.
1 property 1 required
ContainerSetSummary
object
Summarized information about a container set
7 properties 7 required
BasicFailedReply
object
1 property 1 required
PlatformServiceImageInfo
object
The docker image that is used to run a service.
4 properties 4 required
ZookeeperNodeInfo
object
Information about a ZooKeeper node.
2 properties 2 required
ContainerSetsSummary
object
Summarized information about container sets
4 properties 4 required
ProxySummary
object
Summarized information about a proxy.
2 properties 2 required
PublicCertChainCollection
object
Collections of public certificate chains for all the defined extra certificates
1 property 1 required
PublicCertChain
object
The public portion of the certificate chain that contains the PEM encoded server certificate, intermediate certificates, and the CA certificate. NOTE: The priv…
1 property 1 required
PlatformServiceInfo
object
The platform service information.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-platform-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Platform 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.