CircleCI

App · 20 actions

Trigger CircleCI pipeline runs on any branch or tag with parameters, watch runs, workflows and jobs through to their outcome, cancel or rerun workflows, collect job artifacts, and manage the environment variables in projects and contexts.

Actions

ActionWhat it does
Cancel workflowCancel a running workflow.
Delete context environment variableRemove an environment variable from a context by name.
Delete project environment variableRemove an environment variable from a project by name.
Get jobGet one job with every step it ran - each step's command, outcome, exit code and timings - to see where a build failed.
Get pipelineGet one pipeline: its name, description, the repository it checks out and where its config file is read from.
Get pipeline runGet one pipeline run: its phase (queued, started, ended), current outcome, any errors, what triggered it and the commit it built.
Get workflowGet one workflow's phase and outcome - for example to wait until it has finished.
List contextsList an organization's contexts - the shared sets of environment variables jobs can use - optionally narrowed by part of a name.
List job artifactsList the files a job stored as artifacts - test reports, coverage, build outputs - with a download URL for each.
List jobsList the jobs of a workflow with each one's number, type, phase, outcome and timings.
List organizationsList the CircleCI organizations you belong to, or find one by its slug (such as gh/acme).
List pipeline runsList a project's recent pipeline runs, or your own recent runs across every project, newest first.
List pipelinesList a project's pipelines - the configurations it builds from - with each one's name, repository and config file path.
List project environment variablesList the names of a project's environment variables.
List projectsList an organization's CircleCI projects, the projects you follow, or find one project by its slug (such as gh/acme/api).
List workflowsList the workflows of a pipeline run, with each one's phase and outcome.
Rerun workflowRerun a finished workflow as a new workflow: every job, only the failed jobs and what depends on them, or jobs you choose.
Set context environment variableCreate or replace an environment variable in a context, so every job using that context gets the new value.
Set project environment variableAdd an environment variable to a project, for its builds to read - for example to rotate a deploy token.
Trigger pipeline runStart a new run of a project's pipeline on a branch or tag, optionally with pipeline parameters.

Cancel workflow

Cancel a running workflow. CircleCI cancels it in the background, so check it with Get workflow afterwards.

Inputs

Workflow IDcircleci_workflow_idtextRequired
The workflow's id, from List workflows or a run's workflows - or paste the workflow's CircleCI URL.

Outputs

cancel_requestedtrue/false
workflow_idtext
Example output
{
  "cancel_requested": true,
  "workflow_id": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091"
}

Delete context environment variable

Remove an environment variable from a context by name.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Contextcontext_idtextRequired
The context. Pick one, or paste its id or settings-page URL.
Variable namenametextRequired
Letters, digits and underscores, e.g. DEPLOY_TOKEN.

Outputs

context_idtext
deletedtrue/false
nametext
Example output
{
  "context_id": "6f5e4d3c-2b1a-4098-8765-43210fedcba9",
  "deleted": true,
  "name": "DEPLOY_TOKEN"
}

Delete project environment variable

Remove an environment variable from a project by name.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Projectproject_idtextRequired
The project. Pick one, or type its slug (gh/acme/api), its id, or paste its CircleCI URL.
Variable namenametextRequired
Letters, digits and underscores, e.g. DEPLOY_TOKEN.

Outputs

deletedtrue/false
nametext
project_idtext
Example output
{
  "deleted": true,
  "name": "DEPLOY_TOKEN",
  "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}

Get job

Get one job with every step it ran - each step's command, outcome, exit code and timings - to see where a build failed.

Inputs

Job IDjob_idtextRequired
The job's id, from List jobs or a run's workflows.

Outputs

ended_attext
idtext
nametext
outcometext
parallelismnumber
phasetext
pipeline_idtext
project_idtext
started_attext
stepslist
typetext
user_idtext
workflow_idtext
Example output
{
  "ended_at": "2026-10-01T12:03:41Z",
  "id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
  "name": "test",
  "outcome": "failed",
  "parallelism": 1,
  "phase": "ended",
  "pipeline_id": "0f9e8d7c-6b5a-4f3e-2d1c-0b9a8f7e6d5c",
  "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "started_at": "2026-10-01T12:00:05Z",
  "steps": [
    {
      "command": "npm test",
      "ended_at": "2026-10-01T12:03:40Z",
      "execution": 0,
      "exit_code": 1,
      "name": "Run tests",
      "num": 102,
      "outcome": "failed",
      "phase": "ended",
      "started_at": "2026-10-01T12:01:00Z",
      "stderr_bytes": 512,
      "stdout_bytes": 20480,
      "type": "run"
    }
  ],
  "type": "build",
  "user_id": "3d4e5f60-7182-4394-a5b6-c7d8e9f0a1b2",
  "workflow_id": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091"
}

Get pipeline

Get one pipeline: its name, description, the repository it checks out and where its config file is read from.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Projectproject_idtextRequired
The project. Pick one, or type its slug (gh/acme/api), its id, or paste its CircleCI URL.
Pipelinepipeline_idtextRequired
The pipeline (the configuration the project builds from). Most projects have one.

Outputs

checkoutobject
configobject
config_file_pathtext
created_attext
descriptiontext
idtext
nametext
project_idtext
repo_full_nametext
Example output
{
  "checkout": {
    "type": "github_app",
    "vcs": {
      "provider": "github",
      "repo_full_name": "acme/api",
      "repo_id": "123"
    }
  },
  "config": {
    "file_path": ".circleci/config.yml",
    "file_type": "yaml",
    "hosted": null,
    "type": "github_app",
    "vcs": {
      "provider": "github",
      "repo_full_name": "acme/api",
      "repo_id": "123"
    }
  },
  "config_file_path": ".circleci/config.yml",
  "created_at": "2026-03-02T10:15:00Z",
  "description": null,
  "id": "0f9e8d7c-6b5a-4f3e-2d1c-0b9a8f7e6d5c",
  "name": "build-and-test",
  "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "repo_full_name": "acme/api"
}

Get pipeline run

Get one pipeline run: its phase (queued, started, ended), current outcome, any errors, what triggered it and the commit it built.

Inputs

Run IDrun_idtextRequired
The run's id, as returned by Trigger pipeline run or List pipeline runs.

Outputs

branchtext
commit_author_logintext
commit_author_nametext
commit_bodytext
commit_subjecttext
commit_urltext
created_attext
current_outcometext
errorslist
event_actiontext
event_typetext
idtext
numbernumber
origin_repository_urltext
phasetext
pipeline_idtext
pipeline_nametext
project_idtext
revisiontext
tagtext
target_repository_urltext
trigger_idtext
trigger_nametext
trigger_typetext
user_idtext
vcs_providertext
warningslist
Example output
{
  "branch": "main",
  "commit_author_login": "ada",
  "commit_author_name": "Ada Lovelace",
  "commit_body": "",
  "commit_subject": "Bump dependencies",
  "commit_url": "https://github.com/acme/api/commit/4f2a9c1",
  "created_at": "2026-10-01T12:00:00Z",
  "current_outcome": "succeeded",
  "errors": [],
  "event_action": null,
  "event_type": "push",
  "id": "7c6b5a49-3827-4615-a0b9-c8d7e6f5a4b3",
  "number": 208,
  "origin_repository_url": "https://github.com/acme/api",
  "phase": "ended",
  "pipeline_id": "0f9e8d7c-6b5a-4f3e-2d1c-0b9a8f7e6d5c",
  "pipeline_name": "build-and-test",
  "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "revision": "4f2a9c1e7b3d5a6f8e0c2b4d6a8f0e1c3b5d7a9f",
  "tag": null,
  "target_repository_url": "https://github.com/acme/api",
  "trigger_id": "b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e",
  "trigger_name": "GitHub push",
  "trigger_type": "github_app",
  "user_id": "3d4e5f60-7182-4394-a5b6-c7d8e9f0a1b2",
  "vcs_provider": "github",
  "warnings": []
}

Get workflow

Get one workflow's phase and outcome - for example to wait until it has finished.

Inputs

Workflow IDcircleci_workflow_idtextRequired
The workflow's id, from List workflows or a run's workflows - or paste the workflow's CircleCI URL.

Outputs

auto_rerunobject
created_attext
current_outcometext
ended_attext
idtext
nametext
outcometext
phasetext
project_idtext
run_idtext
tagtext
user_idtext
Example output
{
  "auto_rerun": null,
  "created_at": "2026-10-01T12:00:01Z",
  "current_outcome": "succeeded",
  "ended_at": "2026-10-01T12:03:42Z",
  "id": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091",
  "name": "build",
  "outcome": "succeeded",
  "phase": "ended",
  "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "run_id": "7c6b5a49-3827-4615-a0b9-c8d7e6f5a4b3",
  "tag": null,
  "user_id": "3d4e5f60-7182-4394-a5b6-c7d8e9f0a1b2"
}

List contexts

List an organization's contexts - the shared sets of environment variables jobs can use - optionally narrowed by part of a name.

Inputs

Organizationorg_idtextRequired
The CircleCI organization. Pick one, or paste its id.
Name containsnametext
Only contexts whose name contains this.
Page cursorcursortext
The next_cursor from a previous page. Leave empty for the first page.
Page sizelimitnumber
How many to return on this page.From 1 to 50.

Outputs

contextslist
Contexts
countnumber
has_moretrue/false
next_cursortext
Example output
{
  "contexts": [
    {
      "created_at": "2025-11-20T09:00:00Z",
      "id": "6f5e4d3c-2b1a-4098-8765-43210fedcba9",
      "name": "production"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": null
}

List job artifacts

List the files a job stored as artifacts - test reports, coverage, build outputs - with a download URL for each.

Inputs

Job IDjob_idtextRequired
The job's id, from List jobs or a run's workflows.

Outputs

artifactslist
Artifacts
countnumber
Example output
{
  "artifacts": [
    {
      "execution": 0,
      "path": "coverage/index.html",
      "url": "https://output.circle-artifacts.com/output/job/9a8b/artifacts/0/coverage/index.html"
    }
  ],
  "count": 1
}

List jobs

List the jobs of a workflow with each one's number, type, phase, outcome and timings.

Inputs

Workflow IDcircleci_workflow_idtextRequired
The workflow's id, from List workflows or a run's workflows - or paste the workflow's CircleCI URL.

Outputs

countnumber
jobslist
Jobs
Example output
{
  "count": 1,
  "jobs": [
    {
      "ended_at": "2026-10-01T12:03:41Z",
      "id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
      "name": "test",
      "number": 412,
      "outcome": "succeeded",
      "phase": "ended",
      "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "started_at": "2026-10-01T12:00:05Z",
      "type": "build",
      "workflow_id": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091"
    }
  ]
}

List organizations

List the CircleCI organizations you belong to, or find one by its slug (such as gh/acme). Returns each organization's id, name and version-control provider.

Inputs

Organization slugslugtext
Find one organization by slug, e.g. gh/acme.
Page cursorcursortext
The next_cursor from a previous page. Leave empty for the first page.
Page sizelimitnumber
How many to return on this page.From 1 to 50.

Outputs

countnumber
has_moretrue/false
next_cursortext
organizationslist
Organizations
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "organizations": [
    {
      "avatar_url": "https://avatars.githubusercontent.com/u/1",
      "id": "5e1c3d2a-8f7b-4c6d-9e0a-1b2c3d4e5f60",
      "name": "acme",
      "vcs_provider": "github"
    }
  ]
}

List pipeline runs

List a project's recent pipeline runs, or your own recent runs across every project, newest first. Each run includes its outcome, branch, commit, and its workflows with their jobs.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Projectproject_idtext
The project whose runs to list. Leave empty and turn on Only my runs to list yours everywhere.
Only my runsonly_minetrue/false
List your own recent runs across all projects.Default: false.
Page cursorcursortext
The next_cursor from a previous page. Leave empty for the first page.
Page sizelimitnumber
How many to return on this page.From 1 to 50.

Outputs

countnumber
has_moretrue/false
next_cursortext
runslist
Runs, newest first
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "runs": [
    {
      "branch": "main",
      "commit_author_login": "ada",
      "commit_author_name": "Ada Lovelace",
      "commit_body": "",
      "commit_subject": "Bump dependencies",
      "commit_url": "https://github.com/acme/api/commit/4f2a9c1",
      "created_at": "2026-10-01T12:00:00Z",
      "current_outcome": "succeeded",
      "errors": [],
      "event_action": null,
      "event_type": "push",
      "id": "7c6b5a49-3827-4615-a0b9-c8d7e6f5a4b3",
      "number": 208,
      "origin_repository_url": "https://github.com/acme/api",
      "phase": "ended",
      "pipeline_id": "0f9e8d7c-6b5a-4f3e-2d1c-0b9a8f7e6d5c",
      "pipeline_name": "build-and-test",
      "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "revision": "4f2a9c1e7b3d5a6f8e0c2b4d6a8f0e1c3b5d7a9f",
      "tag": null,
      "target_repository_url": "https://github.com/acme/api",
      "trigger_id": "b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e",
      "trigger_name": "GitHub push",
      "trigger_type": "github_app",
      "user_id": "3d4e5f60-7182-4394-a5b6-c7d8e9f0a1b2",
      "vcs_provider": "github",
      "warnings": [],
      "workflow_count": 1,
      "workflows": [
        {
          "auto_rerun": null,
          "created_at": "2026-10-01T12:00:01Z",
          "current_outcome": "succeeded",
          "ended_at": "2026-10-01T12:03:42Z",
          "id": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091",
          "job_count": 1,
          "jobs": [
            {
              "ended_at": "2026-10-01T12:03:41Z",
              "id": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
              "name": "test",
              "number": 412,
              "outcome": "succeeded",
              "phase": "ended",
              "started_at": "2026-10-01T12:00:05Z",
              "type": "build"
            }
          ],
          "jobs_truncated": false,
          "name": "build",
          "outcome": "succeeded",
          "phase": "ended",
          "tag": null
        }
      ],
      "workflows_truncated": false
    }
  ]
}

List pipelines

List a project's pipelines - the configurations it builds from - with each one's name, repository and config file path.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Projectproject_idtextRequired
The project. Pick one, or type its slug (gh/acme/api), its id, or paste its CircleCI URL.

Outputs

countnumber
pipelineslist
Pipelines
Example output
{
  "count": 1,
  "pipelines": [
    {
      "checkout": {
        "type": "github_app",
        "vcs": {
          "provider": "github",
          "repo_full_name": "acme/api",
          "repo_id": "123"
        }
      },
      "config": {
        "file_path": ".circleci/config.yml",
        "file_type": "yaml",
        "hosted": null,
        "type": "github_app",
        "vcs": {
          "provider": "github",
          "repo_full_name": "acme/api",
          "repo_id": "123"
        }
      },
      "config_file_path": ".circleci/config.yml",
      "created_at": "2026-03-02T10:15:00Z",
      "description": null,
      "id": "0f9e8d7c-6b5a-4f3e-2d1c-0b9a8f7e6d5c",
      "name": "build-and-test",
      "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "repo_full_name": "acme/api"
    }
  ]
}

List project environment variables

List the names of a project's environment variables. CircleCI only ever shows the values masked.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Projectproject_idtextRequired
The project. Pick one, or type its slug (gh/acme/api), its id, or paste its CircleCI URL.

Outputs

countnumber
environment_variableslist
Environment variables (values masked)
Example output
{
  "count": 1,
  "environment_variables": [
    {
      "name": "DEPLOY_TOKEN",
      "value": "xxxxa1b2"
    }
  ]
}

List projects

List an organization's CircleCI projects, the projects you follow, or find one project by its slug (such as gh/acme/api). Narrow an organization's projects by name and sort by name or recent activity.

Inputs

Organizationorg_idtext
The CircleCI organization. Pick one, or paste its id.
Only followed projectsfollowingtrue/false
Only projects you follow.Default: false.
Project slugslugtext
Find one project by slug, e.g. gh/acme/api. Use it on its own, without the other filters.
Name containsnametext
Narrow the organization's projects by name.
Sort byorder_bytext
How to order the projects.One of: name, last_active_at (Most recently active). Default: name.
Page cursorcursortext
The next_cursor from a previous page. Leave empty for the first page.
Page sizelimitnumber
How many to return on this page.From 1 to 50.

Outputs

countnumber
has_moretrue/false
next_cursortext
projectslist
Projects
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "projects": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "is_followed": true,
      "name": "api",
      "org_id": "5e1c3d2a-8f7b-4c6d-9e0a-1b2c3d4e5f60",
      "org_name": "acme"
    }
  ]
}

List workflows

List the workflows of a pipeline run, with each one's phase and outcome.

Inputs

Run IDrun_idtextRequired
The run's id, as returned by Trigger pipeline run or List pipeline runs.
Orderorder_bytext
Which workflows come first.One of: created desc (Newest first), created asc (Oldest first). Default: created desc.
Page cursorcursortext
The next_cursor from a previous page. Leave empty for the first page.
Page sizelimitnumber
How many to return on this page.From 1 to 50.

Outputs

countnumber
has_moretrue/false
next_cursortext
workflowslist
Workflows
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "workflows": [
    {
      "auto_rerun": null,
      "created_at": "2026-10-01T12:00:01Z",
      "current_outcome": "succeeded",
      "ended_at": "2026-10-01T12:03:42Z",
      "id": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091",
      "name": "build",
      "outcome": "succeeded",
      "phase": "ended",
      "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "run_id": "7c6b5a49-3827-4615-a0b9-c8d7e6f5a4b3",
      "tag": null,
      "user_id": "3d4e5f60-7182-4394-a5b6-c7d8e9f0a1b2"
    }
  ]
}

Rerun workflow

Rerun a finished workflow as a new workflow: every job, only the failed jobs and what depends on them, or jobs you choose. Optionally with SSH enabled for debugging. Returns the new workflow's id.

Inputs

Workflow IDcircleci_workflow_idtextRequired
The workflow's id, from List workflows or a run's workflows - or paste the workflow's CircleCI URL.
Only failed jobsfrom_failedtrue/false
Rerun only the failed jobs and their dependents.Default: false.
Enable SSHenable_sshtrue/false
Rerun with SSH access enabled.Default: false.
Jobs to rerunjob_idslist
Rerun only these jobs (ids from List jobs). Leave empty to rerun every job.

Outputs

rerun_oftext
workflow_idtext
Example output
{
  "rerun_of": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091",
  "workflow_id": "4d5e6f70-8192-4a3b-b4c5-d6e7f8091a2b"
}

Set context environment variable

Create or replace an environment variable in a context, so every job using that context gets the new value.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Contextcontext_idtextRequired
The context. Pick one, or paste its id or settings-page URL.
Variable namenametextRequired
Letters, digits and underscores, e.g. DEPLOY_TOKEN.
ValuevaluetextRequired
The value. CircleCI stores it encrypted and never shows it again.

Outputs

context_idtext
created_attext
nametext
updated_attext
Example output
{
  "context_id": "6f5e4d3c-2b1a-4098-8765-43210fedcba9",
  "created_at": "2025-11-20T09:05:00Z",
  "name": "DEPLOY_TOKEN",
  "updated_at": "2026-10-01T12:00:00Z"
}

Set project environment variable

Add an environment variable to a project, for its builds to read - for example to rotate a deploy token.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Projectproject_idtextRequired
The project. Pick one, or type its slug (gh/acme/api), its id, or paste its CircleCI URL.
Variable namenametextRequired
Letters, digits and underscores, e.g. DEPLOY_TOKEN.
ValuevaluetextRequired
The value. CircleCI stores it encrypted and never shows it again.

Outputs

nametext
project_idtext
valuetext
Example output
{
  "name": "DEPLOY_TOKEN",
  "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "value": "xxxxa1b2"
}

Trigger pipeline run

Start a new run of a project's pipeline on a branch or tag, optionally with pipeline parameters. The config is read from the same branch or tag unless you name another. Returns the new run's id to watch with Get pipeline run or List workflows.

Inputs

Organizationorg_idtext
The organization whose projects to offer below. Only used to fill the Project list - it is not sent.
Projectproject_idtextRequired
The project. Pick one, or type its slug (gh/acme/api), its id, or paste its CircleCI URL.
Pipelinepipeline_idtextRequired
The pipeline (the configuration the project builds from). Most projects have one.
Branchbranchtext
The branch to build. Leave this and Tag empty for the default branch.
Tagtagtext
A tag to build instead of a branch.
Config branchconfig_branchtext
Read the config from this branch instead. Usually left empty.
Config tagconfig_tagtext
Read the config from this tag instead. Usually left empty.
Pipeline parametersparametersobject
Values for parameters your config declares. true/false are sent as booleans and whole numbers as integers; wrap a value in double quotes, e.g. "123", to send it as text.

Outputs

created_attext
pipeline_idtext
project_idtext
run_idtext
user_idtext
Example output
{
  "created_at": "2026-10-01T12:00:00Z",
  "pipeline_id": "0f9e8d7c-6b5a-4f3e-2d1c-0b9a8f7e6d5c",
  "project_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "run_id": "7c6b5a49-3827-4615-a0b9-c8d7e6f5a4b3",
  "user_id": "3d4e5f60-7182-4394-a5b6-c7d8e9f0a1b2"
}

On this page