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

Kestra Flows API

Manage flow definitions.

Kestra Flows API is one of 7 APIs that Kestra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Flows. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against 2 base URLs: http://localhost:8080, https://{host}.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
http://localhost:8080
https://{host}
Authentication
HTTP Basic
Contact
License
Resource Areas
1

Authentication & Security 1

Kestra Flows API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Optional HTTP basic authentication for self-hosted Kestra instances.

Paths & Operations 5

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

Flows 5

Manage flow definitions.

GET
/api/v1/flows
Search flows
searchFlows 4 params → 200
POST
/api/v1/flows
Create a flow
createFlow body → 200
GET
/api/v1/flows/{namespace}/{id}
Get a flow
getFlow 2 params → 200
PUT
/api/v1/flows/{namespace}/{id}
Update a flow
updateFlow 2 params body → 200
DELETE
/api/v1/flows/{namespace}/{id}
Delete a flow
deleteFlow 2 params → 204

Schemas 2

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

Flow
object
5 properties
FlowPage
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kestra-flows-api-openapi.yml Raw ↑

Other APIs Kestra publishes across the network.

Kestra Enterprise API
Kestra Executions API
Kestra Files API
Kestra KVStore API
Kestra Namespaces API
Kestra Triggers API