Skip to main content

API Overview

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Flux exposes a REST API, an event stream (SSE and Kafka), and a set of webhooks.

Base URL

https://<workspace>.flux.commercemind.se/api/v1

Authentication

All requests must include a bearer token:

GET /runs HTTP/1.1
Host: acme.flux.commercemind.se
Authorization: Bearer flx_live_9b3f...
Accept: application/json

Tokens are scoped to a workspace and carry a role (viewer, operator, admin). The currently authenticated subject is returned by GET /whoami.

Resource model

ResourceDescription
pipelinesPipeline definitions and schedules
runsIndividual executions of a pipeline
stepsEvents emitted by a single step within a run
sinksRegistered outbound destinations
secretsOpaque credentials referenced from pipelines

Pagination

List endpoints are cursor-paginated:

{
"data": [ /* ... */ ],
"next_cursor": "eyJvZmZzZXQiOjUwfQ==",
"has_more": true
}

Pass ?cursor=<value> to continue. Cursors are opaque — do not parse them.