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

Manage integration flows

Elastic.io Flows 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 Flows. 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 8 operations across 5 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.

8 operations 5 paths 9 schemas 1 DELETE2 GET1 PATCH4 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 Flows 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 8

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

Flows 8

Manage integration flows

GET
/flows
Elastic.io List flows
listFlows 3 params → 200401
POST
/flows
Elastic.io Create a flow
createFlow body → 201401409
GET
/flows/{flow_id}
Elastic.io Get a flow
getFlow 1 param → 200401404
PATCH
/flows/{flow_id}
Elastic.io Update a flow
updateFlow 1 param body → 200401404
DELETE
/flows/{flow_id}
Elastic.io Delete a flow
deleteFlow 1 param → 204401404
POST
/flows/{flow_id}/start
Elastic.io Start a flow
startFlow 1 param → 200401404
POST
/flows/{flow_id}/stop
Elastic.io Stop a flow
stopFlow 1 param → 200401404
POST
/flows/{flow_id}/run-now
Elastic.io Run a flow on demand
runFlowNow 1 param → 200401404

Schemas 9

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

ErrorResponse
object
1 property
JsonApiMeta
object
4 properties
FlowResponse
object
1 property
JsonApiLinks
object
5 properties
FlowListResponse
object
3 properties
Flow
object
4 properties
FlowCreateRequest
object
1 property 1 required
JsonApiRelationship
object
1 property
FlowUpdateRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Elastic.io publishes across the network.

Elastic.io Agents API
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 Logs API
Elastic.io Quota Usages API