Management API

The Management API is a Go REST + WebSocket service that powers the Datafly Signal management interface. It provides programmatic access to all platform configuration: pipelines, integrations (catalog, templates, revisions), transformations, users, and audit logs.

Base URL

All endpoints are prefixed with:

https://{cluster}/api/v1/admin

In local development, the Management API runs on port 8084:

http://localhost:8084/v1/admin

Authentication

All requests must include a valid JWT access token in the Authorization header:

Authorization: Bearer {access_token}

Obtain tokens via the authentication endpoints. Access tokens expire after 15 minutes; use the refresh endpoint to obtain new ones.

Content Type

All request and response bodies use JSON:

Content-Type: application/json

Rate Limiting

The API enforces a rate limit of 100 requests per minute per authenticated user. When the limit is exceeded, the API returns a 429 Too Many Requests response with a Retry-After header indicating when the client can retry.

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 32 seconds."
  }
}

Pagination

List endpoints use cursor-based pagination. Pass a cursor and limit as query parameters:

GET /v1/admin/sources?cursor=eyJpZCI6MTAwfQ&limit=50

Paginated responses include a next_cursor field. When next_cursor is null, there are no more results.

{
  "data": [ ... ],
  "next_cursor": "eyJpZCI6MTUwfQ",
  "has_more": true
}

Error Format

All error responses follow a consistent format:

{
  "error": {
    "code": "INVALID_PIPELINE_KEY",
    "message": "The provided pipeline key is not valid or has been revoked."
  }
}

HTTP Status Codes

Sections