# CircleCI integration

> CI/CD platform API for pipelines, workflows, jobs, artifacts, test results, contexts, schedules, webhooks, and build insights.

- Authentication: apiKey

## Tools (111)

- **Add or update an environment variable**: Create or update an environment variable within a context.
- **Approve a job**: Approves a pending approval job in a workflow.
- **Cancel a workflow**: Cancels a running workflow by its UUID.
- **Cancel job by job ID**: Cancel a job with a given job UUID.
- **Cancel job by job number**: Cancels a job by its per-project job number.
- **Continue a pipeline**: Continues a pipeline from the setup phase (dynamic configuration).
- **Create a group**: Creates a new group under the organization (standalone orgs only).
- **Create a new checkout key**: Creates a deploy-key or user-key checkout key for a project (not GitLab/GitHub App projects).
- **Create a new context**: Creates a new context in the specified organization.
- **Create a new organization**: Creates a CircleCI organization (validates and syncs VCS orgs; creates standalone orgs).
- **Create a new project**: Creates a new project in an organization. Works for all organization types.
- **Create an OTLP exporter**: Creates an OTLP exporter configuration for an organization (experimental, max 5 per org).
- **Create an outbound webhook**: Creates an outbound webhook for workflow-completed / job-completed events on a project.
- **Create a project environment variable**: Creates a new environment variable on a project.
- **Create a schedule**: Creates a scheduled pipeline trigger (bitbucket/github orgs; GitHub OAuth definitions only).
- **Create a URL Orb allow-list entry**: Creates a new URL Orb allow-list entry for an organization.
- **Create a usage export**: Submits a request to create a usage export for an organization (async; poll the get endpoint).
- **Create context restriction**: Creates a project, expression, or group restriction on a context.
- **Create pipeline definition**: Creates a pipeline definition (github_app / github_server config sources only).
- **Create policy bundle**: Replaces the current policy bundle for a context with the provided one.
- **Create trigger**: Creates a trigger for a pipeline definition (github/webhook/schedule event sources).
- **Delete a checkout key**: Deletes a checkout key by md5 or sha256 fingerprint.
- **Delete a context**: Delete a context by its ID, including all environment variables inside it.
- **Delete a group**: Deletes a group, its members, and role grants tied to it (standalone orgs only).
- **Delete an organization**: Deletes an organization including all projects and build data.
- **Delete an OTLP exporter**: Deletes an OTLP exporter configuration by ID (experimental).
- **Delete an outbound webhook**: Deletes an existing outbound webhook by its unique ID.
- **Delete a project**: Deletes a project by project slug.
- **Delete a project environment variable**: Deletes a project environment variable by name.
- **Delete a schedule**: Deletes a schedule by ID (GitHub OAuth / Bitbucket Cloud pipeline definitions only).
- **Delete context restriction**: Deletes a project, expression, or group restriction from a context.
- **Delete org-level OIDC claims**: Deletes org-level custom claims of OIDC identity tokens.
- **Delete pipeline definition**: Deletes a pipeline definition (github_app / github_server / bitbucket_dc).
- **Delete project-level OIDC claims**: Deletes project-level custom claims of OIDC identity tokens.
- **Delete trigger**: Deletes a pipeline trigger.
- **Get a checkout key**: Returns an individual checkout key by md5 or sha256 fingerprint.
- **Get a context**: Returns basic information about a context.
- **Get a decision audit log by ID**: Retrieves a policy decision for a given decision log ID.
- **Get a group**: Gets details for a group in an organization (standalone orgs only).
- **Get a job by ID**: Gets a job's metadata by its unique UUID: name, number, type, status, and resource IDs.
- **Get a list of pipelines**: All pipelines for the most recently built projects (max 250) you follow in an organization.
- **Get all branches for a project**: Lists branches currently available within Insights for a project (max 5,000).
- **Get all checkout keys**: Returns the checkout keys for a project.
- **Get all pipelines for a project**: Returns all pipelines for a project, optionally filtered by branch.
- **Get a masked environment variable**: Returns the masked value of a project environment variable.
- **Get an organization**: Retrieve an organization by slug or ID.
- **Get a pipeline by ID**: Returns a pipeline by its UUID.
- **Get a pipeline by pipeline number**: Returns a pipeline by its per-project pipeline number.
- **Get a pipeline's configuration**: Returns a pipeline's source and compiled configuration by ID.
- **Get a pipeline's workflows**: Returns a paginated list of workflows by pipeline ID.
- **Get a policy document**: Retrieves a single policy document by name from the context's bundle.
- **Get a project**: Retrieves a project by project slug.
- **Get a schedule by ID**: Gets a schedule by ID (GitHub OAuth / Bitbucket Cloud pipeline definitions only).
- **Get a usage export**: Gets a usage export job's state and download URLs.
- **Get a webhook**: Returns an outbound webhook by its unique ID.
- **Get a workflow**: Returns summary fields of a workflow by its UUID.
- **Get a workflow's jobs**: Returns the sequence of jobs for a workflow, including each job's id, name, status, and job number.
- **Get Component**: Get the details of a deploy component by ID.
- **Get context restrictions**: Gets a list of project and expression restrictions associated with a context.
- **Get Current User**: Information about the user the token belongs to.
- **Get decision audit logs**: Lists config-policy decision audit logs made using the owner's policies.
- **Get Environment**: Gets a deploy environment by ID.
- **Get flaky tests for a project**: Lists flaky tests (passed and failed in the same commit) for a project.
- **Get metrics and trends for a workflow**: Metrics and trends for a particular workflow on a single branch or all branches.
- **Get org-level OIDC claims**: Fetches org-level custom claims of OIDC identity tokens.
- **Get org summary metrics**: Aggregated summary metrics with trends for the entire org and each project in it.
- **Get pipeline definition**: Gets details for a pipeline definition.
- **Get pipeline values for a pipeline**: Returns a map of pipeline values by pipeline ID.
- **Get policy bundle**: Retrieves the current policy bundle for a context.
- **Get policy bundle for a decision log**: Retrieves the policy bundle used for a given decision log ID.
- **Get project-level OIDC claims**: Fetches project-level custom claims of OIDC identity tokens.
- **Get project settings**: Returns the advanced settings for a CircleCI project.
- **Get project summary metrics and trends**: Summary metrics and trends for a project at workflow and branch level (up to 90-day window).
- **Get recent runs of a workflow**: Recent runs of a workflow (up to 90 days back) with status, duration, and credits.
- **Get summary metrics for a project's workflows**: Summary metrics for a project's workflows over up to 90 days; refreshed daily.
- **Get summary metrics for a workflow's jobs**: Summary metrics for a project workflow's jobs over up to 90 days; refreshed daily.
- **Get test metrics for a workflow**: Test metrics for a project's workflow, calculated from the 10 most recent runs.
- **Get the decision settings**: Retrieves the current config-policy decision settings (e.g. policy evaluation enabled/disabled).
- **Get trigger**: Gets details for a pipeline trigger.
- **Get User by ID**: Information about the user with the given ID.
- **Get your pipelines**: Returns all pipelines for a project that were triggered by the current user.
- **Job timeseries data**: Timeseries data for all jobs within a workflow (hourly retained 48h, daily 90 days).
- **List all project environment variables**: Lists a project's environment variables with masked values.
- **List Collaborations**: The set of organizations the current user is a member of or collaborator on.
- **List Components**: Lists deploy components for a given organization ID.
- **List Component Versions**: List the versions for a deploy component.
- **List contexts**: List all contexts for an owner.
- **List Environments**: Lists deploy environments for a given organization ID.
- **List environment variables**: List environment variables in a context, not including their values.
- **List groups in an organization**: Gets all the groups in an organization.
- **List OTLP exporters**: Lists OTLP exporter configurations for an organization (experimental).
- **List pipeline definitions**: Lists all pipeline definitions for a project.
- **List pipeline definition triggers**: Lists all triggers for a pipeline definition.
- **List schedule triggers**: Lists schedules for a project (GitHub OAuth / Bitbucket Cloud pipeline definitions only).
- **List URL Orb allow-list entries**: Lists the entries in the org's URL Orb allow-list.
- **List webhooks**: Lists outbound webhooks for a given scope (project).
- **Make a policy decision**: Evaluates input config+metadata against the owner's stored policies and returns a decision.
- **Patch org-level OIDC claims**: Creates/updates org-level custom claims of OIDC identity tokens.
- **Patch project-level OIDC claims**: Creates/updates project-level custom claims of OIDC identity tokens.
- **Remove an environment variable**: Delete an environment variable from a context.
- **Remove a URL Orb allow-list entry**: Removes an entry from the org's URL orb allow-list.
- **Rerun a workflow**: Reruns a workflow, optionally from the failed job or a subset of jobs.
- **Rollback a project**: Triggers a rollback pipeline for a deploy component.
- **Set the decision settings**: Modifies config-policy decision settings (e.g. enable/disable policy evaluation).
- **Trigger a Pipeline**: Triggers a pipeline for a pipeline definition (the recommended trigger endpoint).
- **Trigger a Pipeline (Legacy)**: Triggers a pipeline on the project (legacy endpoint; superseded by the newer trigger API, no GitLab/GitHub App support).
- **Update an outbound webhook**: Updates an existing outbound webhook by its unique ID.
- **Update a schedule**: Updates a schedule (GitHub OAuth / Bitbucket Cloud pipeline definitions only).
- **Update pipeline definition**: Updates a pipeline definition (github_app / github_server / bitbucket_dc).
- **Update project settings**: Updates one or more advanced settings for a CircleCI project.
- **Update trigger**: Updates a pipeline trigger's preset, refs, event source, or disabled state.

## Triggers (1)

- **Workflow Completed in CircleCI**: Triggers when a CircleCI workflow finishes (success, failed, error, or canceled) on a project.

## Related prompts

- [Tell real CircleCI failures from flaky tests in Slack](https://www.generalinput.com/prompts/tell-real-circleci-failures-from-flaky-tests-in-slack.md)
- [Turn failed CircleCI builds into tracked Linear issues](https://www.generalinput.com/prompts/turn-failed-circleci-builds-into-tracked-linear-issues.md)
- [Weekly CircleCI test-health report posted to Slack](https://www.generalinput.com/prompts/weekly-circleci-test-health-report-posted-to-slack.md)
- [Log every CircleCI build to a Google Sheet automatically](https://www.generalinput.com/prompts/log-every-circleci-build-to-a-google-sheet-automatically.md)

Connect CircleCI in General Input: https://www.generalinput.com/apps/circleci