CircleCI

Delete a context by its ID. Will also delete all environment variables inside the context. via DELETE /context/{context_id}

Delete an environment variable from a context. via DELETE /context/{context_id}/environment-variable/{env_var_name}

Deletes a project, expression or group restriction from a context. via DELETE /context/{context_id}/restrictions/{restriction_id}

Deletes org-level custom claims of OIDC identity tokens via DELETE /org/{orgID}/oidc-custom-claims

Deletes project-level custom claims of OIDC identity tokens via DELETE /org/{orgID}/project/{projectID}/oidc-custom-claims

Delete an organization. This action will delete all projects including all build data for the organization. via DELETE /organization/{org-slug-or-id}

Remove an entry from the org's URL orb allow-list via DELETE /organization/{org-slug-or-id}/url-orb-allow-list/{allow-list-entry-id}

Delete a group in an organization. This will remove all members from the group as well, and the subsequent role grants tied to the group. Currently only supported for standalone organizations. via DELETE /organizations/{org_id}/groups/{group_id}

[__EXPERIMENTAL__] Deletes an OTLP exporter configuration by ID. via DELETE /otel/exporters/{otel_exporter_id}

Deletes a project by project slug via DELETE /project/{project-slug}

Deletes the checkout key via md5 or sha256 fingerprint. sha256 keys should be url-encoded. via DELETE /project/{project-slug}/checkout-key/{fingerprint}

Deletes the environment variable named :name. via DELETE /project/{project-slug}/envvar/{name}

Delete pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via DELETE /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}

Delete a trigger. Currently only supported for triggers where `event_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, `webhook`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via DELETE /projects/{project_id}/triggers/{trigger_id}

Deletes a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions. via DELETE /schedule/{schedule-id}

Deletes an existing outbound webhook by its unique ID. via DELETE /webhook/{webhook_id}

List all contexts for an owner. via GET /context

Returns basic information about a context. via GET /context/{context_id}

List information about environment variables in a context, not including their values. via GET /context/{context_id}/environment-variable

Gets a list of project and expression restrictions associated with a context. via GET /context/{context_id}/restrictions

Allows for listing of components for a given organization ID. via GET /deploy/components

Get the details of a component by ID. via GET /deploy/components/{component_id}

List the versions for a component. via GET /deploy/components/{component_id}/versions

Allows listing environments for a given organization ID. via GET /deploy/environments

Allows getting an environment for a given environment ID. via GET /deploy/environments/{environment_id}

Gets aggregated summary metrics with trends for the entire org. Also gets aggregated metrics and trends for each project belonging to the org. via GET /insights/{org-slug}/summary

Get a list of all branches for a specified project. The list will only contain branches currently available within Insights. The maximum number of branches returned by this endpoint is 5,000. via GET /insights/{project-slug}/branches

Get a list of flaky tests for a given project. Flaky tests are branch agnostic. A flaky test is a test that passed and failed in the same commit. via GET /insights/{project-slug}/flaky-tests

Get summary metrics for a project's workflows. Workflow runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. via GET /insights/{project-slug}/workflows

Get recent runs of a workflow. Runs going back at most 90 days are returned. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. via GET /insights/{project-slug}/workflows/{workflow-name}

Get summary metrics for a project workflow's jobs. Job runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. via GET /insights/{project-slug}/workflows/{workflow-name}/jobs

Get the metrics and trends for a particular workflow on a single branch or all branches via GET /insights/{project-slug}/workflows/{workflow-name}/summary

Get test metrics for a project's workflows. Currently tests metrics are calculated based on 10 most recent workflow runs. via GET /insights/{project-slug}/workflows/{workflow-name}/test-metrics

Get summary metrics and trends for a project at workflow and branch level. Workflow runs going back at most 90 days are included in the aggregation window. Trends are only supported upto last 30 days. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI. via GET /insights/pages/{project-slug}/summary

Get timeseries data for all jobs within a workflow. Hourly granularity data is only retained for 48 hours while daily granularity data is retained for 90 days. via GET /insights/time-series/{project-slug}/workflows/{workflow-name}/jobs

Gets a job's metadata by its unique ID, including its name, job number, type, status, and associated resource IDs. via GET /jobs/{job_id}

Provides information about the user that is currently signed in. via GET /me

Provides the set of organizations of which a user is a member or a collaborator. The set of organizations that a user can collaborate on is composed of: * Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) * The parent organization of repository that the user can collaborate on, but is not necessarily a member of * The organization of the current user's account via GET /me/collaborations

Fetches org-level custom claims of OIDC identity tokens via GET /org/{orgID}/oidc-custom-claims

Fetches project-level custom claims of OIDC identity tokens via GET /org/{orgID}/project/{projectID}/oidc-custom-claims

Retrieve an organization by slug or ID via GET /organization/{org-slug-or-id}

List the entries in the org's URL Orb allow-list via GET /organization/{org-slug-or-id}/url-orb-allow-list

Get all the groups in an organization. via GET /organizations/{org_id}/groups

Get details for a group in an organization. Currently only supported for standalone organizations. via GET /organizations/{org_id}/groups/{group_id}

Gets a usage export for an organization. via GET /organizations/{org_id}/usage_export_job/{usage_export_job_id}

[__EXPERIMENTAL__] Returns a list of OTLP exporter configurations for the given organization. via GET /otel/exporters

This endpoint will return a list of decision audit logs that were made using this owner's policies. via GET /owner/{ownerID}/context/{context}/decision

This endpoint will retrieve a decision for a given decision log ID via GET /owner/{ownerID}/context/{context}/decision/{decisionID}

This endpoint will retrieve a policy bundle for a given decision log ID via GET /owner/{ownerID}/context/{context}/decision/{decisionID}/policy-bundle

This endpoint retrieves the current decision settings (eg enable/disable policy evaluation) via GET /owner/{ownerID}/context/{context}/decision/settings

This endpoint will retrieve a policy bundle via GET /owner/{ownerID}/context/{context}/policy-bundle

This endpoint will retrieve a policy document. via GET /owner/{ownerID}/context/{context}/policy-bundle/{policyName}

Returns all pipelines for the most recently built projects (max 250) you follow in an organization. via GET /pipeline

Returns a pipeline by the pipeline ID. via GET /pipeline/{pipeline-id}

Returns a pipeline's configuration by ID. via GET /pipeline/{pipeline-id}/config

Returns a map of pipeline values by pipeline ID. For more information see the [pipeline values reference page](https://circleci.com/docs/variables/#pipeline-values). via GET /pipeline/{pipeline_id}/values

Returns a paginated list of workflows by pipeline ID. via GET /pipeline/{pipeline-id}/workflow

Retrieves a project by project slug. via GET /project/{project-slug}

Returns a sequence of checkout keys for `:project`. via GET /project/{project-slug}/checkout-key

Returns an individual checkout key via md5 or sha256 fingerprint. sha256 keys should be url-encoded. via GET /project/{project-slug}/checkout-key/{fingerprint}

Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website. via GET /project/{project-slug}/envvar

Returns the masked value of environment variable :name. via GET /project/{project-slug}/envvar/{name}

Returns all pipelines for this project. via GET /project/{project-slug}/pipeline

Returns a pipeline by the pipeline number. via GET /project/{project-slug}/pipeline/{pipeline-number}

Returns a sequence of all pipelines for this project triggered by the user. via GET /project/{project-slug}/pipeline/mine

For a given project, returns all schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions. Does not return schedule triggers associated with GitHub App pipelines. To fetch schedule triggers associated with GitHub App pipelines, use the [List pipeline definition triggers](https://circleci.com/docs/api/v2/index.html#tag/Trigger/operation/listPipelineDefinitionTriggers] endpoint. via GET /project/{project-slug}/schedule

Returns a list of the advanced settings for a CircleCI project, whether enabled (true) or not (false). via GET /project/{provider}/{organization}/{project}/settings

List all pipeline definitions for a given project. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via GET /projects/{project_id}/pipeline-definitions

Get details for a pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, `github_oauth`, `bitbucket_dc`, `bitbucket_oauth` or `gitlab`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via GET /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}

List all triggers for a given pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via GET /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers

Get details for a trigger. Currently only supported for triggers where `event_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, `webhook`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via GET /projects/{project_id}/triggers/{trigger_id}

Get a schedule by id. via GET /schedule/{schedule-id}

Provides information about the user with the given ID. via GET /user/{id}

Get a list of outbound webhooks that match the given scope-type and scope-id. via GET /webhook

Get an outbound webhook by id. via GET /webhook/{webhook_id}

Returns summary fields of a workflow by ID. via GET /workflow/{id}

Returns a sequence of jobs for a workflow. via GET /workflow/{id}/job

Creates/Updates org-level custom claims of OIDC identity tokens via PATCH /org/{orgID}/oidc-custom-claims

Creates/Updates project-level custom claims of OIDC identity tokens via PATCH /org/{orgID}/project/{projectID}/oidc-custom-claims

This endpoint allows modifying decision settings (eg enable/disable policy evaluation) via PATCH /owner/{ownerID}/context/{context}/decision/settings

Updates one or more of the advanced settings for a CircleCI project. via PATCH /project/{provider}/{organization}/{project}/settings

Update pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, or `bitbucket_dc`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via PATCH /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}

Update a trigger. Currently only supported for triggers where `event_source.provider` is `github_oauth`, `github_app`, `github_server`, `bitbucket_dc`, `webhook`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via PATCH /projects/{project_id}/triggers/{trigger_id}

Updates a schedule and returns the updated schedule. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions. To update schedule triggers for GitHub App pipeline definitions, use the [Update trigger](https://circleci.com/docs/api/v2/index.html#tag/Trigger/operation/updateTrigger) endpoint. via PATCH /schedule/{schedule-id}

Creates a new context in the specified organization. via POST /context

Creates project or expression restriction on a context. via POST /context/{context_id}/restrictions

Cancel job with a given job ID. via POST /jobs/{job-id}/cancel

Create a new organization. For VCS providers (GitHub/Bitbucket), this validates access and syncs org data. For standalone orgs, this creates a new CircleCI organization. via POST /organization

Create a new project. Works for all organization types. via POST /organization/{org-slug-or-id}/project

Create a new URL Orb allow-list entry via POST /organization/{org-slug-or-id}/url-orb-allow-list

Create a new group under the organization. Currently only supported for standalone organizations. via POST /organizations/{org_id}/groups

Submits a request to create a usage export for an organization. via POST /organizations/{org_id}/usage_export_job

[__EXPERIMENTAL__] Creates a new OTLP exporter configuration for the given organization. A maximum of 5 exporter configurations are allowed per organization. via POST /otel/exporters

This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision. via POST /owner/{ownerID}/context/{context}/decision

This endpoint replaces the current policy bundle with the provided policy bundle via POST /owner/{ownerID}/context/{context}/policy-bundle

Continue a pipeline from the setup phase. For information on using pipeline parameters with dynamic configuration, see the [Pipeline values and parameters](https://circleci.com/docs/pipeline-variables/#pipeline-parameters-and-dynamic-configuration) docs. via POST /pipeline/continue

Not available to projects that use GitLab or GitHub App. Creates a new checkout key. This API request is only usable with a user API token. Please ensure that you have authorized your account with GitHub before creating user keys. This is necessary to give CircleCI the permission to create a user key associated with your GitHub user account. You can find this page by visiting Project Settings > Checkout SSH Keys via POST /project/{project-slug}/checkout-key

Creates a new environment variable. via POST /project/{project-slug}/envvar

Cancel job with a given job number. via POST /project/{project-slug}/job/{job-number}/cancel

**[This endpoint is superseded by the [new Trigger Pipeline API](#tag/Pipeline/operation/triggerPipelineRun), which supports all organization and pipeline types except GitLab.]** Triggers a new pipeline on the project. Does not support triggering pipelines integrated with GitLab or GitHub App. via POST /project/{project-slug}/pipeline

Creates a schedule and returns the created schedule. Available only on organizations of type `bitbucket` and `github`, and for the latter will exclusively create schedule triggers associated with the GitHub OAuth pipeline definition. For projects of type `circleci`, or to create schedule triggers for GitHub App pipeline definitions, use the [Create trigger](https://circleci.com/docs/api/v2/index.html#tag/Trigger/operation/createTrigger) endpoint. via POST /project/{project-slug}/schedule

Trigger a pipeline given a pipeline definition ID. Currently only supported for pipeline definitions where `config_source.provider` is `github_app`, `github_server`, `github_oauth`, `bitbucket_dc`, or `bitbucket_oauth`. The slash-separated project slug is shown in Project Settings > Overview. Depending on the organization type, the project slug may have a human-readable format (`vcs_type/org_name/project_name`) or be an opaque string (e.g. `circleci/43G3lM5RtfFE7v5sa4nWAU/44n9wujWcTnVZ2b5S8Fnat`). via POST /project/{provider}/{organization}/{project}/pipeline/run

Create a pipeline definition for a given project. Currently only supported for pipeline definitions where `config_source.provider` is `github_app` or `github_server`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via POST /projects/{project_id}/pipeline-definitions

Create a trigger for a given pipeline definition. Currently only supported for pipeline definitions where `config_source.provider` is `github_oauth`, `github_app`, `github_server`, or `schedule`. [Share feedback](https://circleci.canny.io/cloud-feature-requests/p/project-administration-apis) about our Project Administration APIs. via POST /projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers

Performs a rollback operation by triggering a rollback pipeline. via POST /projects/{project_id}/rollback

Creates an outbound webhook for the given scope. via POST /webhook

Approves a pending approval job in a workflow. via POST /workflow/{id}/approve/{approval_request_id}

Cancels a running workflow. via POST /workflow/{id}/cancel

Reruns a workflow. via POST /workflow/{id}/rerun

Create or update an environment variable within a context. Returns information about the environment variable, not including its value. via PUT /context/{context_id}/environment-variable/{env_var_name}

Updates an existing outbound webhook by its unique ID. via PUT /webhook/{webhook_id}