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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Elastic Stack (ELK Stack)

Elastic Stack (ELK Stack) Roles API

Manage the roles that grant Elasticsearch and Kibana privileges.

Documentation Provider Profile APIs.io OpenAPI GitHub

Elastic Stack (ELK Stack) Roles 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 Roles. 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 13 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://{kibana_url}.

5 operations 3 paths 13 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Elastic Stack (ELK Stack) Roles API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 5

Across 3 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.

roles 5

Manage the roles that grant Elasticsearch and Kibana privileges.

GET
/api/security/role
Get all roles
get-security-role 1 param → 200
DELETE
/api/security/role/{name}
Delete a role
delete-security-role-name 2 params → 204
GET
/api/security/role/{name}
Get a role
get-security-role-name 2 params → 200
PUT
/api/security/role/{name}
Create or update a role
put-security-role-name 3 params body → 204
POST
/api/security/roles
Create or update roles
post-security-roles 1 param body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Kibana_HTTP_APIs_security_role_response (8 properties), Kibana_HTTP_APIs_security_role_remote_indices_privileges (6 properties), Kibana_HTTP_APIs_security_role_indices_privileges (5 properties), Kibana_HTTP_APIs_security_role_elasticsearch (5 properties). Each schema is shown below with its type and property counts.

Kibana_HTTP_APIs_security_role_kibana_application
object
A raw Elasticsearch application privilege entry tied to Kibana.
3 properties 3 required
Kibana_HTTP_APIs_security_role_kibana_privilege_response
object
A Kibana privilege entry returned for a role.
4 properties 3 required
Kibana_HTTP_APIs_security_role_response
object
A Kibana role definition returned by the Roles API.
8 properties 3 required
Kibana_HTTP_APIs_security_role_kibana_privilege
object
The Kibana privilege entry for the role.
3 properties 1 required
Kibana_HTTP_APIs_security_bulk_roles_error_detail
object
Error information for a single role in a bulk create-or-update request.
2 properties 2 required
Kibana_HTTP_APIs_security_role_indices_privileges
object
The indices privileges entry.
5 properties 2 required
Kibana_HTTP_APIs_security_role_put_payload
object
The role definition to create or update.
4 properties 1 required
Kibana_HTTP_APIs_security_role_remote_indices_privileges
object
The remote indices privileges entry.
6 properties 3 required
Kibana_HTTP_APIs_security_role_transform_error
object
Diagnostic information about a role whose Kibana privileges could not be transformed.
2 properties 1 required
Kibana_HTTP_APIs_security_role_remote_cluster_privileges
object
The remote cluster privileges entry.
2 properties 2 required
Kibana_HTTP_APIs_security_role_elasticsearch
object
The Elasticsearch cluster, index, and remote cluster security privileges for the role.
5 properties
Kibana_HTTP_APIs_security_roles_bulk_create_or_update_payload
object
The request body for bulk creating or updating roles.
1 property 1 required
Kibana_HTTP_APIs_security_bulk_create_or_update_roles_response
object
The response payload for the bulk create-or-update roles API.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
AE Profile APIs.io
Elastic Stack (ELK Stack) Accounts API
AE Profile APIs.io
Elastic Stack (ELK Stack) Actions API
AE Profile APIs.io
Elastic Stack (ELK Stack) agent builder API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting API
AE Profile APIs.io
Elastic Stack (ELK Stack) Alerting V2 API
AE Profile APIs.io
Elastic Stack (ELK Stack) Analytics API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent configuration API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM agent keys API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM annotations API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM server schema API
AE Profile APIs.io
Elastic Stack (ELK Stack) APM sourcemaps API
AE Profile APIs.io
#Roles
← Back to E APIs
API Details
ID
elk-stack:elk-stack-roles-api
Base URL
https://{elasticsearch_endpoint}
Docs
https://www.elastic.co/docs/api/doc/elasticsearch/
Provider
Elastic Stack (ELK Stack)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=elk-stack-roles-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/elk-stack-roles-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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