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 Security API

The PlatformConfigurationSecurity API from Elastic Stack (ELK Stack) — 12 operation(s) for platformconfigurationsecurity.

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

This API exposes 22 operations across 12 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.

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

22 operations 12 paths 37 schemas 4 DELETE7 GET7 POST4 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 Security 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 22

Across 12 paths, the API surfaces 22 operations — 4 DELETE, 7 GET, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

PlatformConfigurationSecurity 22
GET
/platform/configuration/security/deployment
Get current security deployment
get-security-deployment → 200404
POST
/platform/configuration/security/deployment
Create security deployment
create-security-deployment body → 201409
PUT
/platform/configuration/security/deployment
Update security deployment
update-security-deployment body → 200409404
GET
/platform/configuration/security/enrollment-tokens
Get enrollment tokens
get-enrollment-tokens → 200
POST
/platform/configuration/security/enrollment-tokens
Create enrollment token
create-enrollment-token body → 200400403
DELETE
/platform/configuration/security/enrollment-tokens/{token}
Delete enrollment token
delete-enrollment-token 1 param → 200404
GET
/platform/configuration/security/realms
List security realm configurations
get-security-realm-configurations → 200
POST
/platform/configuration/security/realms/_reorder
Reorder security realms
reorder-security-realms body → 200400
POST
/platform/configuration/security/realms/active-directory
Create Active Directory configuration
create-active-directory-configuration body → 201400
GET
/platform/configuration/security/realms/active-directory/{realm_id}
Get Active Directory configuration
get-active-directory-configuration 1 param → 200404
PUT
/platform/configuration/security/realms/active-directory/{realm_id}
Update Active Directory configuration
update-active-directory-configuration 2 params body → 200400404409
DELETE
/platform/configuration/security/realms/active-directory/{realm_id}
Delete Active Directory configuration
delete-active-directory-configuration 2 params → 200404409
POST
/platform/configuration/security/realms/ldap
Create LDAP configuration
create-ldap-configuration body → 201400
GET
/platform/configuration/security/realms/ldap/{realm_id}
Get LDAP configuration
get-ldap-configuration 1 param → 200404
PUT
/platform/configuration/security/realms/ldap/{realm_id}
Update LDAP configuration
update-ldap-configuration 2 params body → 200400404409
DELETE
/platform/configuration/security/realms/ldap/{realm_id}
Delete LDAP configuration
delete-ldap-configuration 2 params → 200404409
POST
/platform/configuration/security/realms/saml
Create SAML configuration
create-saml-configuration body → 201400
GET
/platform/configuration/security/realms/saml/{realm_id}
Get SAML configuration
get-saml-configuration 1 param → 200404
PUT
/platform/configuration/security/realms/saml/{realm_id}
Update SAML configuration
update-saml-configuration 2 params body → 200400404409
DELETE
/platform/configuration/security/realms/saml/{realm_id}
Delete SAML configuration
delete-saml-configuration 2 params → 200404409
GET
/platform/configuration/security/tls/{service_name}
Get TLS certificate
get-tls-certificate 1 param → 200
POST
/platform/configuration/security/tls/{service_name}
Set TLS certificate
set-tls-certificate 1 param body → 202

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are SamlSettings (19 properties), LdapSettings (19 properties), ActiveDirectorySettings (17 properties), SecurityDeployment (8 properties). Each schema is shown below with its type and property counts.

LdapUserSearch
object
The user search configuration for the Elasticsearch security LDAP realm.
3 properties
SecurityDeployment
object
The Elasticsearch security deployment.
8 properties 6 required
ActiveDirectorySettings
object
Elasticsearch Security Active Directory realm configuration
17 properties 5 required
SamlAttributeSettings
object
The mapping configuration for the Elasticsearch security SAML attribute.
5 properties 2 required
SamlSpSettings
object
The configuration for the Elasticsearch security SAML Service Provider.
3 properties 3 required
ActiveDirectorySecurityRealmRoleMappingRule
object
Elasticsearch Security Active Directory role mapping rule
3 properties 3 required
SecurityDeploymentCreateRequest
object
The creation request for the Elasticsearch security deployment.
3 properties
SecurityDeploymentTopology
object
The cluster topology for the Elasticsearch security deployment.
2 properties
LdapSettings
object
The configuration for the Elasticsearch security LDAP realm.
19 properties 5 required
BasicFailedReplyElement
object
3 properties 2 required
UpdatedTlsChain
object
Details on the updated TLS chain
1 property 1 required
TlsPublicCertChain
object
The public portion of the certificate chain that contains the PEM encoded server certificate, intermediate certificates, and the CA certificate. NOTE: The priv…
4 properties 2 required
RequestEnrollmentTokenReply
object
Returns the enrollment token that is used to securely start a new server with designated roles.
2 properties 1 required
EnrollmentTokenRequest
object
An enrollment token request for one or more services.
3 properties 1 required
SecurityRealmsReorderRequest
object
A reorder request for Elasticsearch security realms.
1 property 1 required
ActiveDirectoryUserSearch
object
Elasticsearch Security Active Directory realm user search configuration
3 properties
SamlSettings
object
The configuration for the Elasticsearch security SAML realm.
19 properties 5 required
LdapSecurityRealmLoadBalance
object
The load balancing configuration for the Elasticsearch security LDAP realm.
2 properties
ActiveDirectorySecurityRealmLoadBalance
object
Elasticsearch Security Active Directory load balancing configuration
2 properties
SamlIdpSettings
object
The configuration for the Elasticsearch security SAML Identity Provider.
3 properties 2 required
ListEnrollmentTokenReply
object
Information about active enrollment tokens.
1 property 1 required
EmptyResponse
object
SecurityDeploymentUpdateRequest
object
The update request for the Elasticsearch security deployment.
2 properties
SecurityRealmInfo
object
The overview for the Elasticsearch security realm.
6 properties 4 required
SamlSecurityRealmRoleMappingRule
object
The mapping rule for the Elasticsearch security SAML role.
3 properties 3 required
LdapSecurityRealmRoleMappingRule
object
The role mapping rule for the Elasticsearch security LDAP realm.
3 properties 3 required
LdapSecurityRealmRoleMappingRules
object
The role mapping ruleset for the Elasticsearch security LDAP realm.
2 properties 2 required
LdapGroupSearch
object
The group search configuration for the Elasticsearch security LDAP realm.
4 properties
ChainStatus
object
Chain expiration information
2 properties 2 required
BasicFailedReply
object
1 property 1 required
TopologySize
object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
2 properties 2 required
ListEnrollmentTokenElement
object
Information about an active enrollment token.
2 properties 2 required
ActiveDirectorySecurityRealmRoleMappingRules
object
Elasticsearch Security Active Directory role mapping rule set
2 properties 2 required
IdResponse
object
1 property 1 required
ActiveDirectoryGroupSearch
object
Elasticsearch Security Active Directory realm group search configuration
2 properties
SecurityRealmInfoList
object
A list of Elasticsearch security realms.
1 property 1 required
SamlSecurityRealmRoleMappingRules
object
The mapping ruleset for the Elasticsearch security SAML role.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-platformconfigurationsecurity-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 Security 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.