CircleCI

Connect your CircleCI account by saving your Personal API Token, after checking it actually works. Create one at app.circleci.com/settings/user/tokens. This manages pipelines, workflows, jobs, insights, contexts, schedules, webhooks, and self-hosted runners in your own CircleCI account/organizations.

Disconnect a CircleCI account. Nothing in CircleCI is changed; the saved Personal API Token is deleted here.

List the connected CircleCI accounts.

Read one CircleCI project in full by its slug (e.g. 'gh/CircleCI-Public/api-preview-docs') -- its VCS info, organization, and default branch.

List a CircleCI project's environment variables (names only -- values are masked/partial by CircleCI's own API).

Create (or overwrite) an environment variable on a CircleCI project. The value is never returned again by CircleCI once set -- only a masked preview.

Permanently delete an environment variable from a CircleCI project. Cannot be undone.

List the checkout (deploy) keys configured on a CircleCI project.

Create a new checkout (deploy) key for a CircleCI project -- either a deploy-key (project-scoped) or a github-user-key (uses the connected VCS user's own permissions).

Permanently delete a checkout key from a CircleCI project by its fingerprint. Cannot be undone -- any builds relying on it will lose repository access.

List pipelines for a CircleCI project, optionally filtered to one branch.

Read one CircleCI pipeline in full by its id (UUID).

Trigger a new CircleCI pipeline run for a project on a branch or tag, optionally passing pipeline parameters declared in .circleci/config.yml.

Continue a setup workflow's pipeline with a configuration (used with dynamic config/'setup' workflows) -- requires the continuation_key handed to the setup job.

Read the source and compiled .circleci/config.yml of one pipeline.

List the workflows that ran as part of one pipeline.

Read one CircleCI workflow in full by its id (UUID) -- status, timing, and which pipeline it belongs to.

List the jobs that ran (or are pending approval) as part of one workflow.

Approve a pending on-hold job in a workflow (a manual approval gate) so the workflow continues.

Cancel a running CircleCI workflow.

Rerun a CircleCI workflow -- either from scratch or only its failed jobs.

Read one CircleCI job in full by its project slug and numeric job number.

Cancel a running CircleCI job by its project slug and numeric job number.

List the build artifacts produced by one CircleCI job (files it uploaded, with download URLs).

List the individual test results (pass/fail, timing) recorded for one CircleCI job, if the job uploaded JUnit/test-metadata via 'store_test_results'.

Read a CircleCI workflow's success-rate/duration/credits Insights summary over a reporting window (last-24-hours through last-90-days).

Read per-job Insights metrics (success rate, median/p95 duration) within one CircleCI workflow -- helps spot which specific job is the bottleneck or the least reliable.

List tests CircleCI has flagged as flaky (intermittently failing) for a project -- helps prioritise test suite reliability work.

Read an organization-wide CircleCI Insights summary across all its projects for a reporting window.

List CircleCI contexts (shared secret groups usable across projects) for an organization.

Create a new CircleCI context -- a named group of secrets shareable across multiple projects in an organization.

Read one CircleCI context in full by its id.

Permanently delete a CircleCI context and every secret stored inside it. Cannot be undone.

List the environment variable NAMES stored in a CircleCI context (values are never returned).

Add or update a secret environment variable in a CircleCI context. The value is never echoed back once set.

Permanently remove one environment variable from a CircleCI context. Cannot be undone.

List scheduled pipeline triggers configured on a CircleCI project.

Create a new scheduled pipeline trigger on a CircleCI project -- runs automatically on the given days/hours/frequency.

Update an existing CircleCI schedule's name, description, or timetable. Only given fields change.

Permanently delete a CircleCI scheduled pipeline trigger. Cannot be undone.

List webhook subscriptions configured on a CircleCI project or organization.

Subscribe to a CircleCI event (workflow-completed, job-completed) -- CircleCI will POST to your URL as things happen.

Update an existing CircleCI webhook's name, URL, events, or signing secret. Only given fields change.

Permanently remove a CircleCI webhook subscription. Cannot be undone.

List the named pipeline definitions configured on a CircleCI project (each maps a config file path to a checkout source, e.g. main config.yml vs a scheduled-only config).

List the triggers (webhook/schedule sources that can start a pipeline) configured on a CircleCI project, by its project id (UUID, from get_project).

Permanently delete a trigger from a CircleCI project. Cannot be undone -- pipelines will no longer start from this source.

Read the CircleCI user identity that owns the connected Personal API Token.

List the VCS organizations/accounts the connected CircleCI user has access to across GitHub/Bitbucket/GitLab.

List self-hosted CircleCI runners (machines you registered to execute jobs), optionally filtered by resource class or namespace.

List the resource classes (named pools of self-hosted runners) defined under a namespace.

Create a new resource class (named pool) for self-hosted CircleCI runners, e.g. 'my-namespace/linux-arm64'.

Permanently delete a self-hosted runner resource class. Cannot be undone -- any runners in it lose their pool.

Create a new auth token that lets a self-hosted runner register itself under a resource class. The token value is only ever returned once, at creation.

List auth tokens issued for a self-hosted runner resource class (never reveals the token value itself, only metadata).

Permanently revoke a self-hosted runner auth token. Cannot be undone -- runners using it can no longer authenticate.

Cancel several CircleCI pipelines' workflows in one call, by explicit pipeline ids. Continues past per-item failures and reports which succeeded/failed.

Build one aggregated health report for a CircleCI project: recent pipeline count/state, flaky test count, and (if a workflow is given) its success rate and p95 duration -- one call instead of manually cross-referencing pipelines/Insights/flaky-tests endpoints.