Skip to main content
CircleCI logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 65
  • Triggers: 0
  • Slug: CIRCLECI
  • Version: 20261101_00

Tools

Slug: CIRCLECI_CANCEL_WORKFLOWCancel a running CircleCI workflow.

Input Parameters

string
required
Unique ID of the running workflow to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_CONTEXTTool to create a new context in CircleCI. Contexts are used to secure and share environment variables across projects. Use this when you need to set up a new environment configuration for your CircleCI workflows.

Input Parameters

string
required
The user-defined name of the context. This name must be unique within the owner scope.
object
required
Owner information specifying who owns this context (organization or account).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_CONTEXT_GRAPHQLCreate a CircleCI context for an organization using the GraphQL API. On success, returns the created context’s ID, name, and creation time.

Input Parameters

string
required
The unique ID of the owner organization (UUID format).
string ("ORGANIZATION")
required
The type of owner - must be ORGANIZATION.
string
required
The name of the context to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_CONTEXT_RESTRICTIONTool to create a context restriction in CircleCI. Use when you need to limit context access based on project, expression rules, or group membership.

Input Parameters

string
required
An opaque identifier of a context.
string ("project" | "expression" | "group")
required
Type of the restriction. Use ‘project’ to restrict by project UUID, ‘expression’ to restrict by expression rule (e.g., branch conditions), or ‘group’ to restrict by group.
string
required
Value used to evaluate the restriction. If the restriction_type is ‘project’, this will be the project UUID. If the restriction_type is ‘expression’, this will be the expression rule (e.g., ‘pipeline.git.branch == “main”’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_ORGANIZATION_ORB_ALLOWLISTTool to create a new URL Orb allow-list entry for an organization. Use when you need to allow URL-based orb references from specific URL prefixes in CircleCI pipelines for an organization.

Input Parameters

string ("github-oauth" | "none" | "bitbucket-oauth" | "github-app")
required
An authentication method to use for fetching URL orb references that match this allow-list entry’s prefix.
string
required
Name of the URL orb allow-list entry.
string
required
URL prefix. URL orb references that start with this prefix will be allowed by this allow-list entry.
string
required
Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_ORGANIZATION_PROJECTTool to create a new project within a CircleCI organization. Use when you need to programmatically set up a new project for CI/CD automation.

Input Parameters

string
required
The name of the project to create.
string
required
Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_ORG_GROUPTool to create a group in an organization. Use when you need to organize users within a CircleCI organization by creating logical groups.

Input Parameters

string
required
Name of the group.
string
required
An opaque identifier of an organization.
string
Description to describe the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_PROJECT_ENV_VARTool to create a new environment variable for a CircleCI project. Use when you need to add a new environment variable that will be available in project builds.

Input Parameters

string
required
The name of the environment variable to create.
string
required
The value of the environment variable.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_CREATE_USAGE_EXPORT_JOBTool to create a usage export job for a CircleCI organization. Use when you need to export usage data for billing, analysis, or reporting purposes. Rate limited to 10 queries per hour. Maximum date window is 32 days, with up to 13 months of historical data available.

Input Parameters

string
required
End date for the usage export in ISO 8601 format (e.g., ‘2026-02-07T23:59:59Z’). Maximum date window is 32 days between start and end.
string
required
Start date for the usage export in ISO 8601 format (e.g., ‘2026-02-01T00:00:00Z’). Maximum date window is 32 days between start and end.
string
required
Organization ID (UUID) to create the usage export for.
array
Array of organization IDs to include in shared context. Use this to include usage data from related organizations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_DELETE_CONTEXT_GRAPHQLDelete a CircleCI context by its UUID using the REST API. This is a destructive operation that removes the context and its associated environment variables.

Input Parameters

string
required
The UUID of the context to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_DELETE_CONTEXT_RESTRICTIONTool to delete a context restriction by its ID. Use when you need to remove a specific restriction from a CircleCI context.

Input Parameters

string
required
An opaque identifier of a context.
string
required
An opaque identifier of a context restriction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_DELETE_NAMESPACE_ALIASTool to remove a namespace alias by name in CircleCI. Use when you need to delete an existing namespace alias that is no longer needed. The mutation returns a boolean indicating success and any errors that occurred during deletion.

Input Parameters

string
required
The name of the namespace alias to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_DELETE_ORGANIZATION_ORB_ALLOWLISTTool to remove an entry from the organization’s URL orb allow-list. Use when you need to revoke access to a previously allowed orb URL.

Input Parameters

string
required
Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings).
string
required
URL orb allow-list entry UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_DELETE_ORG_GROUPTool to delete a group from a CircleCI organization. Use when you need to remove a group permanently from the organization.

Input Parameters

string
required
An opaque identifier of an organization.
string
required
An opaque identifier of a group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_DELETE_PROJECTTool to delete a CircleCI project and its settings. Use when you need to permanently remove a project from CircleCI. This action cannot be undone.

Input Parameters

string
required
Project slug in the form ‘vcs-slug/org-name/repo-name’. The ’/’ characters may be URL-escaped. For projects that use GitLab or GitHub App, use ‘circleci’ as the ‘vcs-slug’, replace ‘org-name’ with the organization ID (found in Organization Settings), and replace ‘repo-name’ with the project ID (found in Project Settings).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_DELETE_PROJECT_ENV_VARTool to delete an environment variable from a CircleCI project. Use when you need to remove an existing environment variable by name.

Input Parameters

string
required
The name of the environment variable to delete.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_CONTEXTTool to retrieve a context by its unique ID. Use when you need details about a specific CircleCI context.

Input Parameters

string
required
An opaque identifier of a context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_CURRENT_USERTool to retrieve information about the currently authenticated user. Use when you need details about the signed-in user’s profile, permissions, and account settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_FLAKY_TESTSTool to get flaky tests for a project. Use when you need to identify tests that passed and failed in the same commit. Branch-agnostic insights help improve test reliability.

Input Parameters

string
required
The project slug in the form ‘vcs-slug/org-name/repo-name’ (e.g., ‘gh/CircleCI-Public/circleci-cli’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_JOB_ARTIFACTSRetrieves artifacts (output files like test results, logs, build binaries, reports) produced by a CircleCI job. Use this when you need to access files generated during a job’s execution, such as test reports, coverage data, compiled binaries, or deployment artifacts. Returns download URLs for each artifact. Note: Jobs may produce zero artifacts if none were explicitly stored using ‘store_artifacts’ in the config.

Input Parameters

integer
required
The number of the job to list artifacts for.
string
Token to retrieve the next page of results. Obtain this from the ‘next_page_token’ field in a previous response.
string
required
The project slug in the form of ‘vcs-slug/org-name/repo-name’, e.g., ‘gh/CircleCI-Public/api-preview-docs’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_JOB_DETAILSTool to fetch details of a specific job within a project. Use when you need status, timing, and executor information for a CircleCI job by its number.

Input Parameters

integer
required
The number of the job to fetch details for.
string
required
The project slug in the form ‘vcs-slug/org-name/repo-name’, e.g., ‘gh/CircleCI-Public/api-preview-docs’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_LEGACY_BUILD_DETAILSRetrieve a legacy CircleCI v1.1 build record.

Input Parameters

string
required
Project repository name.
string
required
Organization or username that owns the project.
string ("github" | "bitbucket")
required
Version-control provider for the project.
integer
required
Positive legacy build number to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_ORB_DETAILSTool to query detailed information about a CircleCI orb using the GraphQL API. Use when you need to retrieve orb metadata, versions, usage statistics, or namespace details.

Input Parameters

string
required
The orb reference in format ‘namespace/orbname’. Use this to query public orbs like ‘circleci/node’ or ‘circleci/python’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_ORB_VERSIONTool to retrieve detailed information about a specific CircleCI orb version via GraphQL. Use when you need orb source code, version history, usage statistics, or metadata for a specific orb version.

Input Parameters

string
required
The orb reference including version information. Format: ‘namespace/orb-name@version’ (e.g., ‘circleci/node@5.0.0’). The namespace identifies the orb publisher, orb-name is the orb identifier, and version is the specific version to query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_ORGANIZATIONTool to retrieve organization details from CircleCI using GraphQL query. Use when you need organization information by ID or by name and VCS type.

Input Parameters

string
The unique UUID of the organization. Either org_id OR both org_name and vcs_type must be provided.
string
The name of the organization. Must be provided together with vcs_type if org_id is not provided.
string
The version control system type. Must be provided together with org_name if org_id is not provided. Common values: GITHUB, BITBUCKET.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_ORGANIZATION_GROUPTool to retrieve a group in an organization. Use when you need to get details about a specific group within a CircleCI organization.

Input Parameters

string
required
An opaque identifier of an organization.
string
required
An opaque identifier of a group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_PIPELINERetrieve metadata for a CircleCI pipeline by its UUID.

Input Parameters

string
required
The unique UUID of the pipeline to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_PIPELINE_CONFIGTool to fetch pipeline configuration by ID. Use when you need the source or compiled YAML of a specific pipeline.

Input Parameters

string
required
The unique ID of the pipeline to fetch configuration for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_PIPELINE_DEFINITIONTool to retrieve a pipeline definition by project and definition ID. Use when you need details about a specific pipeline definition’s configuration, sources, and metadata.

Input Parameters

string
required
An opaque identifier of a project.
string
required
An opaque identifier of a pipeline definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_PIPELINE_VALUESRetrieve the runtime values resolved for a CircleCI pipeline.

Input Parameters

string
required
Pipeline UUID whose runtime values should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_PROJECTTool to retrieve a CircleCI project by its slug. Use when you need project details such as organization info, project ID, or VCS configuration.

Input Parameters

string
required
Project slug in the form vcs-slug/org-name/repo-name (e.g., gh/CircleCI-Public/circleci-cli). The / characters may be URL-escaped.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_PROJECT_WORKFLOWSGet summary metrics for a project’s workflows, including success rates, duration, throughput, and credits used. Results are paginated; use the returned next-page token to retrieve further workflows.

Input Parameters

string
The name of a vcs branch. If not passed we will scope the API call to the default branch.
string
Token to retrieve the next page of results (for pagination).
boolean
Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
string
The time window for the report. Specifies the reporting window for data aggregation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_TEST_METADATATool to fetch test metadata for a specific job. Use when you need detailed test results, run times, and failure messages after a job completes.

Input Parameters

integer
Maximum number of test results to return. Defaults to 30.
integer
required
The number of the job to fetch test metadata for.
string
A token to retrieve the next page of results.
string
required
The project slug in the form ‘vcs-slug/org-name/repo-name’, e.g., ‘gh/CircleCI-Public/circleci-cli’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_USAGE_EXPORT_JOBTool to retrieve a usage export job by organization ID and job ID. Use when you need to check the status or download URLs of a usage export job.

Input Parameters

string
required
An opaque identifier of an organization.
string
required
An opaque identifier of a usage export job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_USER_INFORMATIONTool to retrieve information about a CircleCI user by their unique ID. Use when you need user profile details after obtaining the user ID.

Input Parameters

string
required
The unique ID of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_GET_WORKFLOW_SUMMARYTool to get metrics and trends for a workflow. Use when you need workflow performance insights including success rates, duration metrics, and trends over time.

Input Parameters

string
The name of a vcs branch. If not passed we will scope the API call to the default branch.
boolean
Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
string
required
The name of the workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_INSPECT_WORKFLOWInspect a workflow’s summary and one page of its jobs.

Input Parameters

string
Token returned by a previous call to retrieve the next jobs page.
string
required
Workflow UUID to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_CONTEXT_ENV_VARSList environment variable names and metadata for a CircleCI context, with pagination.

Input Parameters

string
required
An opaque identifier of a context.
string
A token to specify which page of results to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_INSIGHTS_BRANCHESTool to get all branches for a project from CircleCI Insights. Use when you need to retrieve the list of branches that have workflow runs in the project.

Input Parameters

string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
string
The name of a workflow. If not passed we will scope the API call to the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_INSIGHTS_SUMMARYTool to get summary metrics with trends for the entire organization and for each project. Use when you need organization-wide performance analytics across all projects.

Input Parameters

string
required
Organization slug in the form vcs-type/org-name. Example: gh/CircleCI-Public or bb/my-org.
string
Filter by project names. Can be a single project name or multiple project names.
string ("last-7-days" | "last-30-days" | "last-60-days" | "last-90-days")
Reporting window for summary metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_NAMESPACE_ORBSTool to list orbs in a CircleCI registry namespace with pagination support. Use when you need to browse available orbs in a namespace, filter by visibility (public/private), or retrieve orb statistics. Returns up to 20 orbs per page with cursor-based pagination.

Input Parameters

string ("PUBLIC_ONLY" | "PRIVATE_ONLY")
Enum for orb visibility filter types.
string
Pagination cursor for fetching subsequent pages. Use empty string for the first page, then use the cursor value from previous response’s edges.
string
The registry namespace name to query (e.g., ‘circleci’, ‘myorg’). If not provided, queries all accessible namespaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_ORB_CATEGORIESTool to retrieve all CircleCI orb categories with pagination support. Use when you need to list available categories for orb classification. Returns up to 20 categories per page with cursor-based pagination.

Input Parameters

string
Pagination cursor for fetching subsequent result pages. Use empty string for first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_ORBSTool to list CircleCI orbs with pagination support via GraphQL API. Use when you need to browse available orbs, filter by certification status, or discover orbs with their usage statistics. Returns up to 20 orbs per page with cursor-based pagination.

Input Parameters

string
Cursor for pagination. Use empty string for the first page, then use the cursor from the previous response to get the next page.
boolean
Filter for certified orbs only (true) or include all orbs (false). Certified orbs are officially verified by CircleCI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_ORGANIZATION_GROUPSList groups in a CircleCI organization, with pagination support. Results contain group identifiers, names, and descriptions.

Input Parameters

integer
The number of results per page.
string
required
An opaque identifier of an organization.
string
A token to specify which page of results to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_PAGES_SUMMARYTool to get summary metrics and trends for a project across its workflows and branches. Use when you need to analyze project performance, track success rates, throughput, credits usage, and duration trends.

Input Parameters

array
The names of VCS branches to include in branch-level workflow metrics.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
array
The names of workflows to include in workflow-level metrics.
string ("last-7-days" | "last-24-hours" | "last-30-days" | "last-60-days" | "last-90-days")
Reporting window for summary metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_PIPELINE_DEFINITIONSList pipeline definitions for a specific project, including their configuration sources. Results are paginated; use the returned next-page token to retrieve further definitions.

Input Parameters

string
A token to retrieve the next page of results.
string
required
An opaque identifier of a project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_PIPELINESTool to get a list of pipelines for an organization. Use when you need to retrieve pipelines across multiple projects or for a specific organization.

Input Parameters

boolean
Only include entries created by your user.
string
Org slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings).
string
A token to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_PIPELINES_FOR_PROJECTList pipelines for a specific project, optionally filtered by branch or current user. Results are paginated; use the returned next-page token to retrieve further pipelines.

Input Parameters

boolean
Only return pipelines triggered by the current user if true.
string
Only return pipelines on this branch.
string
A token to retrieve the next page of results.
string
required
The project slug in the form vcs-slug/org-name/repo-name (e.g., github/CircleCI-Public/circleci-cli).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_PROJECT_ENV_VARSList project-level environment variables for a CircleCI project. Values are masked for security; results are paginated, with a token for retrieving the next page.

Input Parameters

string
Token to fetch the next page of results.
string
required
Project slug in the form ‘vcs-slug/org-name/repo-name’. The vcs-slug should be ‘gh’ (GitHub) or ‘bb’ (Bitbucket). Example: ‘gh/CircleCI-Public/api-preview-docs’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_PROJECT_SCHEDULESList scheduled pipeline triggers for a specific project. Results are paginated; use the returned next-page token to retrieve further schedules.

Input Parameters

string
A token to retrieve the next page of results.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_SELF_HOSTED_RUNNERSList CircleCI self-hosted runners for exactly one namespace or resource class. A 404 response is returned as an empty list.

Input Parameters

string
Filter runners by namespace (e.g., ‘my-namespace’). Returns all runners in the specified namespace. Must provide either this or resource_class (but not both).
string
Filter runners by specific resource class (e.g., ‘my-namespace/my-resource-class’). Returns only runners for this resource class. Must provide either this or namespace (but not both).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_USER_COLLABORATIONSTool to retrieve organizations where the authenticated user has access. Use when you need to list all organizations a user can collaborate on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_WORKFLOWS_BY_PIPELINE_IDTool to list all workflows associated with a specific pipeline. Use when you need to fetch or paginate through workflows by pipeline ID.

Input Parameters

integer
Maximum number of workflows to return. Default is 20, maximum is 100.
string
Token to retrieve the next page of results (for pagination).
string
required
The unique identifier of the pipeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_WORKFLOWS_JOBS_WORKFLOWSTool to get summary metrics for a project workflow’s jobs. Use when you need performance analytics like success rates, duration statistics, and credit usage for jobs in a specific workflow.

Input Parameters

string
The name of a vcs branch. If not passed we will scope the API call to the default branch.
string
The name of the jobs you would like to filter from your workflow. If not specified, all workflow jobs will be returned. The job name can either be the full job name or just a substring of the job name.
string
A token to retrieve the next page of results.
boolean
Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
string
required
The name of the workflow.
string ("last-7-days" | "last-24-hours" | "last-30-days" | "last-60-days" | "last-90-days")
Time window for calculating summary metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_LIST_WORKFLOWS_TEST_METRICSTool to get test metrics for a project’s workflows. Use when you need to analyze test performance, identify flaky tests, or find the slowest tests in a workflow.

Input Parameters

string
The name of a vcs branch. If not passed we will scope the API call to the default branch.
boolean
Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
string
required
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
string
required
The name of the workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_CONTEXTRetrieve a CircleCI context by UUID using the GraphQL API, including its ID, name, and creation time. The context field in the returned data can be null.

Input Parameters

string
required
The UUID of the context to query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_NAMESPACE_EXISTSTool to determine if a namespace exists in the CircleCI registry. Use when you need to verify namespace existence before performing operations. Returns a boolean indicating whether the namespace exists.

Input Parameters

string
required
The namespace name to check existence for (e.g., ‘circleci’, ‘myorg’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_ORB_CATEGORY_IDQuery a CircleCI orb category ID by category name. The result contains a nullable orbCategoryByName field within data.

Input Parameters

string
required
The name of the orb category to query (e.g., Deployment, Testing, Security, Notifications).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_ORB_EXISTSTool to check if an orb exists in CircleCI registry and retrieve its privacy status. Use when you need to verify orb existence or check if an orb is private/public. Returns null in the data.orb field if the orb does not exist.

Input Parameters

string
required
Full orb name in format ‘namespace/orb’ (e.g., ‘circleci/node’).
string
Optional namespace name to verify its existence alongside the orb.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_ORB_IDTool to fetch an orb’s ID and optionally its namespace ID by orb name. Use when you need to query orb identifiers for CircleCI orbs. The name parameter should be the full orb reference (namespace/orbname). Optionally provide the namespace parameter to also retrieve the namespace ID in the same call.

Input Parameters

string
required
Full orb reference in format namespace/orbname (e.g., ‘circleci/node’, ‘myorg/myorb’).
string
Namespace name to query the namespace ID (e.g., ‘circleci’, ‘myorg’). Optional but recommended to get both orb and namespace IDs in one call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_ORB_LATEST_VERSIONQuery the latest published version of a CircleCI orb for dependency management or updates. The result contains a nullable orb field within data.

Input Parameters

string
required
The orb reference in format ‘namespace/orbname’ (e.g., ‘circleci/node’, ‘circleci/aws-cli’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_ORB_SOURCETool to retrieve source code of a specific CircleCI orb version via GraphQL. Use when you need to access the YAML configuration or inspect the implementation of an orb version. Returns null if the orb version reference does not exist.

Input Parameters

string
required
The orb reference including version information. Format: ‘namespace/orb-name@version’ (e.g., ‘circleci/node@5.0.0’). The namespace identifies the orb publisher, orb-name is the orb identifier, and version is the specific version to retrieve source for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_QUERY_PLAN_METRICSTool to query plan metrics including credit usage by project and organization for a date range. Use when you need to analyze credit consumption, compute time usage, or project-level metrics for an organization.

Input Parameters

string
required
The unique UUID of the organization to query plan metrics for.
object
required
Date range to filter metrics. Specify start and end dates in ISO 8601 format (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_REMOVE_CONTEXT_ENV_VAR_GRAPHQLTool to remove an environment variable from a CircleCI context using GraphQL API. Use when you need to delete a context-level environment variable by its name.

Input Parameters

string
required
The name of the environment variable to remove from the context.
string
required
The UUID of the context containing the environment variable to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_RENAME_NAMESPACETool to rename a CircleCI namespace by its UUID identifier. Use when you need to change the name of an existing namespace. Returns the renamed namespace ID on success, or errors if the operation fails.

Input Parameters

string
required
The new name for the namespace.
string
required
The unique identifier (UUID) of the namespace to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_RERUN_WORKFLOWRerun a CircleCI workflow, optionally selecting jobs or failed work.

Input Parameters

array
Specific job IDs to rerun. Cannot be used with from_failed.
boolean
Whether to enable SSH access. Requires jobs.
boolean
Whether to rerun from the failed job. Cannot be used with jobs, enable_ssh, or sparse_tree.
boolean
Whether to use sparse-tree rerun logic. Requires jobs.
string
required
Unique ID of the workflow to rerun.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_STORE_ENVIRONMENT_VARIABLETool to store an environment variable in a CircleCI context using GraphQL mutation. Use when you need to add or update an environment variable within a specific context.

Input Parameters

string
required
The value of the environment variable to store.
string
required
The name of the environment variable to store.
string
required
The UUID of the context to store the environment variable in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_TRIGGER_PIPELINETriggers a new CI/CD pipeline run for a specified CircleCI project. Use this tool to programmatically start a build on a specific branch or tag, optionally passing custom pipeline parameters for conditional workflow execution. Requires write access to the project.

Input Parameters

string
The git tag to trigger the pipeline on. Use this to trigger builds for tagged releases. Cannot be used together with ‘branch’.
string
The branch name to trigger the pipeline on. If not specified, triggers on the project’s default branch. Cannot be used together with ‘tag’.
object
Pipeline parameters as key-value pairs to pass to the CircleCI config. These parameters must be declared in your .circleci/config.yml file. Useful for conditional workflow execution or dynamic configuration.
string
required
Project identifier in the format ‘vcs-slug/org-name/repo-name’. The vcs-slug should be ‘gh’ (GitHub) or ‘bb’ (Bitbucket). Example: ‘gh/my-org/my-repo’ for a GitHub project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_UPSERT_CONTEXT_ENV_VARTool to add or update an environment variable in a CircleCI context. Use when you need to set or modify context-level environment variables for your CircleCI projects.

Input Parameters

string
required
The value of the environment variable.
string
required
An opaque identifier of a context.
string
required
The name of the environment variable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CIRCLECI_VALIDATE_ORB_CONFIGTool to validate CircleCI orb YAML configuration using the orbConfig GraphQL query. Use when you need to verify that an orb definition is syntactically correct before publishing or using it. Returns validation status, any errors found, and the processed YAML output.

Input Parameters

string
required
The YAML configuration of the orb to validate. Must be a valid YAML string containing orb definition with version, description, commands, jobs, or executors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not