Skip to content

Server API Reference ​

The CI server exposes a JSON API for pipeline and run management.

All endpoints support optional basic authentication (if configured).

Endpoints by Category ​

  • Pipelines — create, list, update, delete, trigger pipelines
  • Runs — query execution history and task logs
  • Webhooks — trigger pipelines via HTTP webhooks
  • Schedules — manage pipeline schedule triggers
  • Drivers — list available orchestration drivers
  • Features — list available feature gates
  • MCP — Model Context Protocol server for AI assistants

Authentication ​

If --basic-auth-username and --basic-auth-password are set on the server, include Authorization: Basic <base64(user:pass)> in requests.

Webhook endpoints do not require basic auth but may validate HMAC signatures (see Webhooks).

Response Format ​

All responses are JSON. Errors include an error field and an HTTP status code.

Standard error response:

json
{
  "error": "pipeline not found"
}