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

Manage on-premises integration agents

Elastic.io Agents 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 Agents. 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 4 operations across 2 paths, and defines 8 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.

4 operations 2 paths 8 schemas 1 DELETE2 GET1 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 Agents 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 4

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

Agents 4

Manage on-premises integration agents

GET
/agents
Elastic.io List agents
listAgents 3 params → 200401
POST
/agents
Elastic.io Create an agent
createAgent body → 201401
GET
/agents/{agent_id}
Elastic.io Get an agent
getAgent 1 param → 200401404
DELETE
/agents/{agent_id}
Elastic.io Delete an agent
deleteAgent 1 param → 204401404

Schemas 8

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

ErrorResponse
object
1 property
AgentListResponse
object
3 properties
JsonApiMeta
object
4 properties
AgentCreateRequest
object
1 property 1 required
JsonApiLinks
object
5 properties
AgentResponse
object
1 property
JsonApiRelationship
object
1 property
Agent
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-io-agents-api-openapi.yml Raw ↑

Other APIs Elastic.io publishes across the network.

Elastic.io Auth Clients API
Elastic.io Auth Secrets 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