CI API Reference

Every operation of the CI API, under /ci/api. Sign requests with an access key (Authorization: EWS-ACCESS-KEY <id>:<secret>). A successful JSON response is { "success": true, "data": … }.

workflows

Workflow files: check one, or convert one from another CI system

runners

Self-hosted machines that claim runs their labels match

runner-groups

Which runs self-hosted runners may take: repositories, refs, protected branches only, pull requests

runner-pools

Machines the platform starts for GitHub-syntax jobs whose labels a pool carries, one job per just-in-time runner

runs

Workflow runs: one per push, pull request or re-run

dispatch

Start a workflow by hand (workflow_dispatch / on.manual)

jobs

One job of a run: a machine running its steps

variables

Configuration variables — the `vars` context of GitHub-syntax workflows

environments

Deployment environments: who may deploy where, from which branches, after whose approval

artifacts

Files a run uploaded, kept until they expire

Generated from the API description, the same one the API checks requests against and the CLI is built from.