Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic.io Auth Secrets API

Manage authentication secrets

Elastic.io Auth Secrets API is one of 22 APIs that Elastic.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Auth Secrets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 3 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.elastic.io/v2.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Server
https://api.elastic.io/v2
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Elastic.io Auth Secrets API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Obtain a token through the elastic.io platform login or API key.

Paths & Operations 5

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

Auth Secrets 5

Manage authentication secrets

GET
/auth-secrets
Elastic.io List auth secrets
listAuthSecrets 3 params → 200401
POST
/auth-secrets
Elastic.io Create an auth secret
createAuthSecret body → 201401
GET
/auth-secrets/{auth_secret_id}
Elastic.io Get an auth secret
getAuthSecret 1 param → 200401404
PATCH
/auth-secrets/{auth_secret_id}
Elastic.io Update an auth secret
updateAuthSecret 1 param body → 200401404
DELETE
/auth-secrets/{auth_secret_id}
Elastic.io Delete an auth secret
deleteAuthSecret 1 param → 204401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are JsonApiLinks (5 properties), AuthSecret (4 properties), JsonApiMeta (4 properties), AuthSecretListResponse (3 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property
AuthSecretResponse
object
1 property
JsonApiMeta
object
4 properties
AuthSecret
object
4 properties
JsonApiLinks
object
5 properties
AuthSecretCreateRequest
object
1 property 1 required
AuthSecretListResponse
object
3 properties
AuthSecretUpdateRequest
object
1 property 1 required
JsonApiRelationship
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-io-auth-secrets-api-openapi.yml Raw ↑

Other APIs Elastic.io publishes across the network.

Elastic.io Agents API
Elastic.io Auth Clients API
Elastic.io Components API
Elastic.io Contracts API
Elastic.io Credentials API
Elastic.io Data Samples API
Elastic.io Executions API
Elastic.io Flow Drafts API
Elastic.io Flow Versions API
Elastic.io Flows API
Elastic.io Logs API
Elastic.io Quota Usages API