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) Users API

The Users API from Elastic Stack (ELK Stack) — 3 operation(s) for users.

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

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

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

7 operations 3 paths 9 schemas 1 DELETE3 GET2 PATCH1 POST

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) Users 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 7

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

Users 7
GET
/user
Fetch current user information
get-current-user → 200401404
PATCH
/user
Updates the current user
update-current-user body → 200400401404
GET
/users
Fetch all users
get-users 1 param → 200
POST
/users
Creates a new user
create-user body → 200400409
GET
/users/{user_name}
Fetch a single user
get-user 1 param → 200404
DELETE
/users/{user_name}
Deletes an existing user
delete-user 1 param → 200400404
PATCH
/users/{user_name}
Updates an existing user
update-user 1 param body → 200400404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are User (6 properties), UserMetadata (6 properties), UserSecurity (6 properties), BasicFailedReplyElement (3 properties). Each schema is shown below with its type and property counts.

BasicFailedReplyElement
object
3 properties 2 required
BasicFailedReply
object
1 property 1 required
EmptyResponse
object
UserSecurity
object
A user's security information
6 properties
ElevatedPermissions
object
A user's elevated permissions status
2 properties 1 required
UserList
object
A collection of users
1 property 1 required
UserSecurityRealm
object
The security realm the user belongs to
2 properties 2 required
UserMetadata
object
Metadata for a user
6 properties
User
object
An API user
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-users-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) Users 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.