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 Configuration Instances API

The PlatformConfigurationInstances API from Elastic Stack (ELK Stack) — 2 operation(s) for platformconfigurationinstances.

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

This API exposes 5 operations across 2 paths, and defines 18 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 2 paths 18 schemas 1 DELETE2 GET1 POST1 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 Configuration Instances 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

PlatformConfigurationInstances 5
GET
/platform/configuration/instances
Get instance configurations
get-instance-configurations 3 params → 200
POST
/platform/configuration/instances
Create instance configuration
create-instance-configuration body → 201400403
GET
/platform/configuration/instances/{id}
Get instance configuration
get-instance-configuration 4 params → 200404
PUT
/platform/configuration/instances/{id}
Set instance configuration
set-instance-configuration 6 params body → 200201400403404
DELETE
/platform/configuration/instances/{id}
Delete a instance configuration
delete-instance-configuration 3 params → 200403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are InstanceConfiguration (15 properties), SimpleQueryStringQuery (13 properties), QueryContainer (11 properties), RangeQuery (7 properties). Each schema is shown below with its type and property counts.

QueryContainer
object
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
11 properties
BasicFailedReplyElement
object
3 properties 2 required
BasicFailedReply
object
1 property 1 required
SimpleQueryStringQuery
object
A query that uses simple query string syntax. Will ignore invalid syntax.
13 properties 1 required
MatchAllQuery
object
A query that matches all documents.
MatchQuery
object
Consumes and analyzes text, numbers, and dates, then constructs a query.
4 properties 1 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
EmptyResponse
object
ExistsQuery
object
Matches documents that have at least one non-null value in the original field.
1 property 1 required
MatchNoneQuery
object
A query that doesn't match any documents.
PrefixQuery
object
The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.
2 properties 1 required
InstanceConfiguration
object
The configuration template for Elasticsearch instances, Kibana instances, and APM Servers.
15 properties 2 required
DiscreteSizes
object
Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration.
3 properties 1 required
NestedQuery
object
A query that matches nested objects.
3 properties 2 required
BoolQuery
object
A query for documents that match boolean combinations of other queries.
5 properties
VersionedIdResponse
object
3 properties 1 required
TermQuery
object
A query for documents that contain the specified term in the inverted index.
1 property 1 required
RangeQuery
object
The query that matches documents with fields that contain terms within a specified range.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-platformconfigurationinstances-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 Configuration Instances 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.