The CircleCI connector lets your AI agent act in each user's CircleCI account. Each user connects their own CircleCI API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.
- Tools
- 30
- What they doRead · write · destructive
- 25 · 5 · 025 read5 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the CircleCI connection
In AgentKit > Connections, create a CircleCI connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'circleci'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize CircleCI:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'circleci_collaborations_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "circleci"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize CircleCI:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="circleci_collaborations_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their CircleCI credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcircleci_collaborations_listList the organizations the connected user is a member of or collaborates on.Read-onlyList Collaborations
List the organizations the connected user is a member of or collaborates on. Returns each organization's id, name, slug (for example gh/acme), vcs_type and avatar_url. Use this first to find the org slug or organization id that the pipeline, context and insights tools need.
Inputs
This tool takes no inputs.
circleci_context_envvars_listList the environment variables stored in a CircleCI context, without their values.Read-onlyList Context Environment Variables
List the environment variables stored in a CircleCI context, without their values. Returns each variable's variable (name), context_id, created_at and updated_at, plus next_page_token. Secret values are never returned. Use this to check which variables a context provides to jobs.
Inputs
context_idstringrequired- UUID of the context, from the id field returned by circleci_contexts_list. Example: 0d4fbe39-e6a0-4b5b-9a8f-3d1a4f1c2e77
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_context_getGet a CircleCI context by its UUID.Read-onlyGet Context
Get a CircleCI context by its UUID. Returns the context's id, name and created_at. Use this to check a context's name. Use circleci_context_envvars_list to see which variables it holds.
Inputs
context_idstringrequired- UUID of the context, from the id field returned by circleci_contexts_list. Example: 0d4fbe39-e6a0-4b5b-9a8f-3d1a4f1c2e77
circleci_contexts_listList the contexts (shared sets of environment variables) that belong to a CircleCI organization.Read-onlyList Contexts
List the contexts (shared sets of environment variables) that belong to a CircleCI organization. Returns each context's id, name and created_at, plus next_page_token. Use this to find a context id for circleci_context_get or circleci_context_envvars_list. Provide owner_id or owner_slug.
Inputs
owner_idstring- UUID of the organization that owns the contexts, from the id field of circleci_collaborations_list or Organization Settings > Overview. Provide this or owner_slug. Example: c9a2d8e4-5f1b-4a7c-8e3d-2b6f9a0c1d4e
owner_slugstring- Organization slug, for example gh/acme, from the slug field of circleci_collaborations_list. Provide this or owner_id. Example: gh/acme
owner_typestring- Type of the owner: organization (the default, for CircleCI cloud) or account (for CircleCI server installations). Example: organizationone of
organizationaccount page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_insights_flaky_tests_listList the flaky tests CircleCI detected in a project, across all branches.Read-onlyList Flaky Tests
List the flaky tests CircleCI detected in a project, across all branches. A flaky test passed and failed on the same commit. Returns flaky_tests with test_name, classname, file, job_name, workflow_name, times_flaked, pipeline_number and time_wasted, plus total_flaky_tests. Use this to find unreliable tests. Use circleci_job_tests_list for the results of one job.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
circleci_insights_org_summary_getGet summary metrics with trends for a whole CircleCI organization and for each of its projects.Read-onlyGet Organization Insights Summary
Get summary metrics with trends for a whole CircleCI organization and for each of its projects. Returns org_data (metrics and trends for total_runs, total_duration_secs, total_credits_used, success_rate, throughput), org_project_data per project, and all_projects. Use this for an organization-wide health overview. Use circleci_insights_workflows_list to drill into one project.
Inputs
org_slugstringrequired- Organization slug in the form vcs-slug/org-name, from the slug field of circleci_collaborations_list. Example: gh/acme
reporting_windowstring- Time window used to calculate the summary metrics. CircleCI uses last-90-days when omitted. One of last-24-hours, last-7-days, last-30-days, last-60-days, last-90-days. Example: last-30-daysone of
last-24-hourslast-7-dayslast-30-dayslast-60-dayslast-90-days
circleci_insights_test_metrics_getGet test metrics for one workflow of a CircleCI project, calculated from its 10 most recent runs.Read-onlyGet Workflow Test Metrics
Get test metrics for one workflow of a CircleCI project, calculated from its 10 most recent runs. Returns average_test_count, total_test_runs, most_failed_tests, slowest_tests (with failed_runs, p95_duration, flaky flag) and test_runs. Use this to find the most failed and slowest tests in a workflow. Use circleci_insights_flaky_tests_list for flaky tests across the project.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
workflow_namestringrequired- Name of the workflow as defined in the project's .circleci/config.yml, for example build-and-test. Use circleci_insights_workflows_list to see the names that have run. Example: build-and-test
all_branchesboolean- Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
branchstring- Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main
circleci_insights_workflow_jobs_listGet summary metrics for each job of one workflow in a CircleCI project over a reporting window.Read-onlyList Workflow Job Insights
Get summary metrics for each job of one workflow in a CircleCI project over a reporting window. Returns per job: name, metrics (total_runs, successful_runs, failed_runs, success_rate, throughput, total_credits_used, duration_metrics) and window_start/window_end, plus next_page_token. Metrics cover up to 90 days, are refreshed daily and may miss the last 24 hours; they are not a billing source. Use this to find the slowest or least reliable jobs in a workflow.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
workflow_namestringrequired- Name of the workflow as defined in the project's .circleci/config.yml, for example build-and-test. Use circleci_insights_workflows_list to see the names that have run. Example: build-and-test
all_branchesboolean- Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
branchstring- Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main
job_namestring- Full job name, or a substring of it, to limit the results to matching jobs. Leave empty for every job. Example: test
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
reporting_windowstring- Time window used to calculate the summary metrics. CircleCI uses last-90-days when omitted. One of last-24-hours, last-7-days, last-30-days, last-60-days, last-90-days. Example: last-30-daysone of
last-24-hourslast-7-dayslast-30-dayslast-60-dayslast-90-days
circleci_insights_workflow_runs_listList recent runs of one workflow in a CircleCI project, optionally within a date range.Read-onlyList Workflow Runs
List recent runs of one workflow in a CircleCI project, optionally within a date range. Returns each run's id, branch, status, duration, created_at, stopped_at and credits_used, plus next_page_token. Runs go back at most 90 days. Use this to see a workflow's run history. Use circleci_insights_workflows_list for aggregated metrics instead.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
workflow_namestringrequired- Name of the workflow as defined in the project's .circleci/config.yml, for example build-and-test. Use circleci_insights_workflows_list to see the names that have run. Example: build-and-test
all_branchesboolean- Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
branchstring- Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main
end_datestring- Include only runs that started before this time, as an ISO 8601 date-time, at most 90 days after start_date. Example: 2026-10-31T00:00:00Z
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
start_datestring- Include only runs that started at or after this time, as an ISO 8601 date-time. Required when end_date is set. Example: 2026-10-01T00:00:00Z
circleci_insights_workflows_listGet summary metrics for each workflow of a CircleCI project over a reporting window.Read-onlyList Workflow Insights
Get summary metrics for each workflow of a CircleCI project over a reporting window. Returns per workflow: name, metrics (total_runs, successful_runs, failed_runs, success_rate, throughput, mttr, total_credits_used, duration_metrics) and window_start/window_end, plus next_page_token. Metrics cover up to 90 days, are refreshed daily and may miss the last 24 hours; they are not a billing source. Use this to compare workflows or find the workflow names the other insights tools take.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
all_branchesboolean- Set to true to aggregate data across all branches instead of a single branch. Use either this or branch, not both. Example: true
branchstring- Name of a VCS branch to limit results to. Defaults to the project's default branch. Do not combine with all_branches. Example: main
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
reporting_windowstring- Time window used to calculate the summary metrics. CircleCI uses last-90-days when omitted. One of last-24-hours, last-7-days, last-30-days, last-60-days, last-90-days. Example: last-30-daysone of
last-24-hourslast-7-dayslast-30-dayslast-60-dayslast-90-days
circleci_job_artifacts_listList the artifacts a CircleCI job stored with store_artifacts.Read-onlyList Job Artifacts
List the artifacts a CircleCI job stored with store_artifacts. Returns each artifact's path, node_index and download url, plus next_page_token. Downloading a url needs the same Circle-Token for private projects. Use this to find build outputs, coverage reports or logs a job saved.
Inputs
job_numberintegerrequired- Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_job_getGet the details of a CircleCI job by project slug and job number.Read-onlyGet Job
Get the details of a CircleCI job by project slug and job number. Returns the job's name, number, status, started_at, stopped_at, duration, executor, parallelism, parallel_runs, messages, contexts, latest_workflow, pipeline and web_url. Use this to see why a job failed or how long it took. Use circleci_job_tests_list for its test results and circleci_job_artifacts_list for its files.
Inputs
job_numberintegerrequired- Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
circleci_job_tests_listList the test results a CircleCI job uploaded with store_test_results.Read-onlyList Job Test Results
List the test results a CircleCI job uploaded with store_test_results. Returns each test's name, classname, file, result (success, failure, skipped), message (failure output), run_time and source, plus next_page_token. Use this to see which tests failed in one job. Use circleci_insights_flaky_tests_list or circleci_insights_test_metrics_get for trends across runs.
Inputs
job_numberintegerrequired- Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_me_getGet the CircleCI user that owns the connected personal API token.Read-onlyGet Current User
Get the CircleCI user that owns the connected personal API token. Returns the user's id, login and name. Use this to confirm which account the connection acts as. Use circleci_collaborations_list to find the organizations that user can reach.
Inputs
This tool takes no inputs.
circleci_pipeline_config_getGet the configuration a CircleCI pipeline ran with.Read-onlyGet Pipeline Configuration
Get the configuration a CircleCI pipeline ran with. Returns source (the config.yml as committed), compiled (the processed config after orbs and parameters are expanded), and setup-config and compiled-setup-config for dynamic config. Use this to see exactly which jobs and steps a pipeline ran, for example when debugging a config change.
Inputs
pipeline_idstringrequired- UUID of the pipeline, from the id field returned by circleci_pipelines_list, circleci_project_pipelines_list or circleci_pipeline_trigger. Example: 5034460f-c7c4-4c43-9457-de07e2029e7b
circleci_pipeline_getGet a CircleCI pipeline by its UUID.Read-onlyGet Pipeline
Get a CircleCI pipeline by its UUID. Returns the pipeline's id, number, project_slug, state, created_at, updated_at, errors, trigger, trigger_parameters and vcs details. Use this when you have a pipeline id. Use circleci_pipeline_get_by_number when you have the project slug and pipeline number from the CircleCI app.
Inputs
pipeline_idstringrequired- UUID of the pipeline, from the id field returned by circleci_pipelines_list, circleci_project_pipelines_list or circleci_pipeline_trigger. Example: 5034460f-c7c4-4c43-9457-de07e2029e7b
circleci_pipeline_get_by_numberGet a pipeline of a CircleCI project by its pipeline number.Read-onlyGet Pipeline by Number
Get a pipeline of a CircleCI project by its pipeline number. Returns the pipeline's id, number, state, created_at, errors, trigger and vcs details. Use this when you have the number shown in the CircleCI app or a pipeline URL. Use circleci_pipeline_get when you have the pipeline id.
Inputs
pipeline_numberintegerrequired- Pipeline number within the project, from the number field of a pipeline or from the pipeline URL in the CircleCI app. Example: 482
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
circleci_pipeline_workflows_listList the workflows of a CircleCI pipeline.Read-onlyList Pipeline Workflows
List the workflows of a CircleCI pipeline. Returns each workflow's id, name, status (success, running, failed, on_hold, canceled and others), created_at, stopped_at, pipeline_number and project_slug, plus next_page_token. Use this after finding a pipeline to get the workflow ids that the workflow and job tools need.
Inputs
pipeline_idstringrequired- UUID of the pipeline, from the id field returned by circleci_pipelines_list, circleci_project_pipelines_list or circleci_pipeline_trigger. Example: 5034460f-c7c4-4c43-9457-de07e2029e7b
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_pipelines_listList recent pipelines across the projects the connected user follows in an organization (up to 250 of the most recently built projects).Read-onlyList Pipelines in Organization
List recent pipelines across the projects the connected user follows in an organization (up to 250 of the most recently built projects). Returns pipelines newest first with id, number, project_slug, state, created_at, trigger (type, actor) and vcs details (branch, revision, commit subject), plus next_page_token. Use this for an organization-wide view. Use circleci_project_pipelines_list for one project or one branch.
Inputs
mineboolean- Set to true to include only pipelines triggered by the connected user. Example: true
org_slugstring- Organization slug in the form vcs-slug/org-name, from the slug field of circleci_collaborations_list. GitHub App and GitLab organizations use circleci/<organization-id>. Example: gh/acme
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_project_envvar_getGet one environment variable of a CircleCI project by name, with its value masked.Read-onlyGet Project Environment Variable
Get one environment variable of a CircleCI project by name, with its value masked. Returns the variable's name, masked value (four x characters plus the last four characters) and created_at; the secret value is never returned. Use this to confirm that a specific variable exists. Use circleci_project_envvars_list to see every variable.
Inputs
namestringrequired- Name of the environment variable, exactly as set in Project Settings > Environment Variables. Example: AWS_ACCESS_KEY_ID
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
circleci_project_envvars_listList the environment variables set on a CircleCI project, with values masked.Read-onlyList Project Environment Variables
List the environment variables set on a CircleCI project, with values masked. Returns each variable's name, masked value (four x characters plus the last four characters of the value) and created_at; secret values are never returned. Use this to see which variables a project defines. Use circleci_project_envvar_get to check one variable by name.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_project_getGet a CircleCI project by its project slug.Read-onlyGet Project
Get a CircleCI project by its project slug. Returns the project's id, slug, name, organization_name, organization_slug, organization_id and vcs_info (VCS URL, provider and default branch). Use this to check a project slug or find a project's id and default branch.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
circleci_project_pipelines_listList the pipelines of one CircleCI project, optionally limited to a branch.Read-onlyList Project Pipelines
List the pipelines of one CircleCI project, optionally limited to a branch. Returns pipelines newest first with id, number, state, created_at, trigger (type, actor), errors and vcs details (branch, revision, commit subject), plus next_page_token. Use this to find the latest pipeline on a branch. Use circleci_pipelines_list for every project in an organization.
Inputs
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
branchstring- Name of a VCS branch to list pipelines for. Leave empty for all branches. Example: main
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_workflow_getGet a CircleCI workflow by its UUID.Read-onlyGet Workflow
Get a CircleCI workflow by its UUID. Returns the workflow's id, name, status, created_at, stopped_at, pipeline_id, pipeline_number, project_slug, started_by and canceled_by. Use this to check whether a workflow passed, failed or is still running. Use circleci_workflow_jobs_list to see its jobs.
Inputs
workflow_idstringrequired- UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21
circleci_workflow_jobs_listList the jobs of a CircleCI workflow.Read-onlyList Workflow Jobs
List the jobs of a CircleCI workflow. Returns each job's id, name, job_number, type (build or approval), status, started_at, stopped_at, dependencies and approval_request_id, plus next_page_token. Use this to find failed jobs and their job numbers before calling circleci_job_get, circleci_job_artifacts_list or circleci_job_tests_list, or to find the approval_request_id for circleci_workflow_approve.
Inputs
workflow_idstringrequired- UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21
page_tokenstring- Pagination token from the next_page_token field of the previous response. Leave empty for the first page. Example: AARLwwV5WgM1TjFGmBJuDWeBbZt7
circleci_job_cancelCancel a running or queued CircleCI job by project slug and job number.WriteCancel Job
Cancel a running or queued CircleCI job by project slug and job number. Returns a message confirming the job was canceled. Use this to stop one job. Use circleci_workflow_cancel to stop a whole workflow.
Inputs
job_numberintegerrequired- Job number within the project, from the job_number field returned by circleci_workflow_jobs_list (also shown in the job's URL in the CircleCI app). Example: 1234
project_slugstringrequired- Project slug in the form vcs-slug/org-name/repo-name, copied from Project Settings > Overview in CircleCI. GitHub OAuth projects use gh/<org>/<repo> and Bitbucket projects bb/<org>/<repo>; GitHub App and GitLab projects use circleci/<organization-id>/<project-id>. Example: gh/acme/web-app
circleci_pipeline_triggerTrigger a new pipeline run for a CircleCI project, optionally on a specific branch or tag and with pipeline parameters.WriteTrigger Pipeline
Trigger a new pipeline run for a CircleCI project, optionally on a specific branch or tag and with pipeline parameters. Returns the new pipeline's id, number, state and created_at. Use this to start a build or deploy. Use circleci_workflow_rerun to rerun an existing workflow instead. Supported for GitHub (OAuth, App or Server) and Bitbucket Cloud projects; GitLab projects are not supported by this endpoint.
Inputs
organizationstringrequired- Second segment of the project slug: the organization name (for example acme) or, for GitHub App projects, the organization id. Example: acme
projectstringrequired- Third segment of the project slug: the repository name (for example web-app) or, for GitHub App projects, the project id. Example: web-app
providerstringrequired- First segment of the project slug shown in Project Settings > Overview: gh or github for GitHub OAuth, bb or bitbucket for Bitbucket, circleci for GitHub App projects. Example: ghone of
ghgithubbbbitbucketcircleci checkout_branchstring- Branch to check out in checkout steps. Do not combine with checkout_tag. For a GitHub pull request use pull/<number>/head or pull/<number>/merge. Example: main
checkout_tagstring- Tag to check out in checkout steps. Do not combine with checkout_branch. Example: v2.4.0
config_branchstring- Branch to read the config file from. Do not combine with config_tag. For a GitHub pull request use pull/<number>/head or pull/<number>/merge. Example: main
config_tagstring- Tag to read the config file from. Do not combine with config_branch. Example: v2.4.0
definition_idstring- UUID of the pipeline definition to run, from Project Settings > Pipelines. Needed when the project has more than one pipeline definition. Example: 2338d0ae-5541-4bbf-88a2-55e9f7281f80
parametersobject- Pipeline parameters declared in the config, as an object of parameter names to string, number or boolean values. Up to 100 entries; keys up to 128 characters and values up to 512. Example: {"deploy_prod": true, "region": "us-east-1"}
circleci_workflow_approveApprove a pending approval job (hold step) in a CircleCI workflow so the jobs after it can run.WriteApprove Workflow Job
Approve a pending approval job (hold step) in a CircleCI workflow so the jobs after it can run. Returns a message confirming the approval was accepted. Use this when a workflow is on_hold. Get the approval_request_id from circleci_workflow_jobs_list (the job with type approval).
Inputs
approval_request_idstringrequired- UUID of the approval job, from the approval_request_id field of the approval-type job returned by circleci_workflow_jobs_list. Example: 2e9d1f7a-4b3c-4d8e-9f01-6a7b8c9d0e1f
workflow_idstringrequired- UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21
circleci_workflow_cancelCancel a running CircleCI workflow, stopping all of its running and queued jobs.WriteCancel Workflow
Cancel a running CircleCI workflow, stopping all of its running and queued jobs. Returns a message confirming the request was accepted. Use this to stop a whole workflow. Use circleci_job_cancel to stop a single job.
Inputs
workflow_idstringrequired- UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21
circleci_workflow_rerunRerun a CircleCI workflow, either in full, from its failed jobs, or for selected jobs.WriteRerun Workflow
Rerun a CircleCI workflow, either in full, from its failed jobs, or for selected jobs. Returns the workflow_id of the new workflow run. Use this to retry a failed or flaky workflow. Use circleci_pipeline_trigger to start a new pipeline from a branch instead.
Inputs
workflow_idstringrequired- UUID of the workflow, from the id field returned by circleci_pipeline_workflows_list. Example: 9c40e8cf-6d47-4b8f-9a2b-7e1f3c0f5a21
enable_sshboolean- Set to true to rerun the selected jobs with SSH access for the connected user. Requires jobs. Example: true
from_failedboolean- Set to true to rerun only the failed jobs and everything downstream of them. Do not combine with jobs. Example: true
jobsarray- Job UUIDs to rerun (the id field from circleci_workflow_jobs_list, not the job number). Do not combine with from_failed. Example: ["c65b68ef-e73b-4bf2-be9a-7a322a9df150"]
sparse_treeboolean- Set to true to rerun only the selected jobs and the jobs connected to them, an optimisation for workflows with disconnected subgraphs. Requires jobs. Example: true
No tools match.