CircleCI API

GET

/me

User Information

GET

/context

List contexts

POST

/context

Create a new context

GET

/webhook

List webhooks

POST

/webhook

Create an outbound webhook

GET

/pipeline

Get a list of pipelines

GET

/user/{id}

User Information

POST

/organization

Create a new organization

GET

/workflow/{id}

Get a workflow

GET

/deploy/components

List Components

GET

/me/collaborations

Collaborations

POST

/pipeline/continue

Continue a pipeline

GET

/workflow/{id}/job

Get a workflow's jobs

GET

/deploy/environments

List Environments

POST

/workflow/{id}/rerun

Rerun a workflow

GET

/context/{context_id}

Get a context

DELETE

/context/{context_id}

Delete a context

POST

/jobs/{job-id}/cancel

Cancel job by job ID

GET

/webhook/{webhook-id}

Get a webhook

PUT

/webhook/{webhook-id}

Update an outbound webhook

DELETE

/webhook/{webhook-id}

Delete an outbound webhook

POST

/workflow/{id}/cancel

Cancel a workflow

GET

/pipeline/{pipeline-id}

Get a pipeline by ID

GET

/project/{project-slug}

Get a project

DELETE

/project/{project-slug}

Delete a project

GET

/schedule/{schedule-id}

Get a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions.

PATCH

/schedule/{schedule-id}

Update a schedule

DELETE

/schedule/{schedule-id}

Delete a schedule

GET

/insights/{org-slug}/summary

Get summary metrics with trends for the entire org, and for each project.

GET

/organization/{org-slug-or-id}

Get an organization

DELETE

/organization/{org-slug-or-id}

Delete an organization

GET

/organizations/{org_id}/groups

Groups in an organization

POST

/organizations/{org_id}/groups

Create Groups

GET

/pipeline/{pipeline-id}/config

Get a pipeline's configuration

GET

/pipeline/{pipeline-id}/values

Get pipeline values for a pipeline

GET

/project/{project-slug}/envvar

List all environment variables

POST

/project/{project-slug}/envvar

Create an environment variable

GET

/org/{orgID}/oidc-custom-claims

Get org-level claims

PATCH

/org/{orgID}/oidc-custom-claims

Patch org-level claims

DELETE

/org/{orgID}/oidc-custom-claims

Delete org-level claims

POST

/projects/{project_id}/rollback

Rollback a project

GET

/pipeline/{pipeline-id}/workflow

Get a pipeline's workflows

GET

/project/{project-slug}/pipeline

Get all pipelines

POST

/project/{project-slug}/pipeline

Trigger a new pipeline

GET

/project/{project-slug}/schedule

List schedule triggers

POST

/project/{project-slug}/schedule

Create a schedule

GET

/deploy/components/{component_id}

Get Component

GET

/insights/{project-slug}/branches

Get all branches for a project

GET

/context/{context_id}/restrictions

Get context restrictions

POST

/context/{context_id}/restrictions

Create context restriction

GET

/insights/{project-slug}/workflows

Get summary metrics for a project's workflows

GET

/insights/{project-slug}/flaky-tests

Get flaky tests for a project

GET

/project/{project-slug}/checkout-key

Get all checkout keys

POST

/project/{project-slug}/checkout-key

Create a new checkout key

GET

/deploy/environments/{environment_id}

Get Environment

GET

/project/{project-slug}/envvar/{name}

Get a masked environment variable

DELETE

/project/{project-slug}/envvar/{name}

Delete an environment variable

GET

/project/{project-slug}/pipeline/mine

Get your pipelines

GET

/insights/pages/{project-slug}/summary

Get summary metrics and trends for a project across it's workflows and branches

POST

/organization/{org-slug-or-id}/project

Create a new project

POST

/organizations/{org_id}/usage_export_job

Create a usage export

GET

/project/{project-slug}/job/{job-number}

Get job details

GET

/organizations/{org_id}/groups/{group_id}

A group in an organization

DELETE

/organizations/{org_id}/groups/{group_id}

Delete a group

GET

/context/{context_id}/environment-variable

List environment variables

GET

/deploy/components/{component_id}/versions

List Component Versions

GET

/project/{project-slug}/{job-number}/tests

Get test metadata

GET

/owner/{ownerID}/context/{context}/decision

Retrieves the owner's decision audit logs.

POST

/owner/{ownerID}/context/{context}/decision

Makes a decision

GET

/projects/{project_id}/pipeline-definitions

List pipeline definitions

POST

/projects/{project_id}/pipeline-definitions

Create pipeline definition

POST

/project/{provider}/{organization}/{project}

⚠️ Create a project

GET

/projects/{project_id}/triggers/{trigger_id}

Get trigger

PATCH

/projects/{project_id}/triggers/{trigger_id}

Update trigger

DELETE

/projects/{project_id}/triggers/{trigger_id}

Delete trigger

POST

/workflow/{id}/approve/{approval_request_id}

Approve a job

GET

/project/{project-slug}/{job-number}/artifacts

Get a job's artifacts

POST

/project/{project-slug}/job/{job-number}/cancel

Cancel job by job number

GET

/owner/{ownerID}/context/{context}/policy-bundle

Retrieves Policy Bundle

POST

/owner/{ownerID}/context/{context}/policy-bundle

Creates policy bundle for the context

GET

/organization/{org-slug-or-id}/url-orb-allow-list

List the entries in the org's URL Orb allow-list

POST

/organization/{org-slug-or-id}/url-orb-allow-list

Create a new URL Orb allow-list entry

GET

/insights/{project-slug}/workflows/{workflow-name}

Get recent runs of a workflow

GET

/project/{project-slug}/checkout-key/{fingerprint}

Get a checkout key

DELETE

/project/{project-slug}/checkout-key/{fingerprint}

Delete a checkout key

GET

/project/{project-slug}/pipeline/{pipeline-number}

Get a pipeline by pipeline number

DELETE

/context/{context_id}/restrictions/{restriction_id}

Delete context restriction

GET

/org/{orgID}/project/{projectID}/oidc-custom-claims

Get project-level claims

PATCH

/org/{orgID}/project/{projectID}/oidc-custom-claims

Patch project-level claims

DELETE

/org/{orgID}/project/{projectID}/oidc-custom-claims

Delete project-level claims

GET

/owner/{ownerID}/context/{context}/decision/settings

Get the decision settings

PATCH

/owner/{ownerID}/context/{context}/decision/settings

Set the decision settings

GET

/project/{provider}/{organization}/{project}/settings

Get project settings

PATCH

/project/{provider}/{organization}/{project}/settings

Update project settings

GET

/insights/{project-slug}/workflows/{workflow-name}/jobs

Get summary metrics for a project workflow's jobs.

GET

/owner/{ownerID}/context/{context}/decision/{decisionID}

Retrieves the owner's decision audit log by given decisionID

PUT

/context/{context_id}/environment-variable/{env_var_name}

Add or update an environment variable

DELETE

/context/{context_id}/environment-variable/{env_var_name}

Remove an environment variable

POST

/project/{provider}/{organization}/{project}/pipeline/run

[Recommended] Trigger a new pipeline

GET

/insights/{project-slug}/workflows/{workflow-name}/summary

Get metrics and trends for workflows

GET

/owner/{ownerID}/context/{context}/policy-bundle/{policyName}

Retrieves a policy document

GET

/organizations/{org_id}/usage_export_job/{usage_export_job_id}

Get a usage export

GET

/insights/{project-slug}/workflows/{workflow-name}/test-metrics

Get test metrics for a project's workflows

GET

/insights/time-series/{project-slug}/workflows/{workflow-name}/jobs

Job timeseries data

GET

/projects/{project_id}/pipeline-definitions/{pipeline_definition_id}

Get pipeline definition

PATCH

/projects/{project_id}/pipeline-definitions/{pipeline_definition_id}

Update pipeline definition

DELETE

/projects/{project_id}/pipeline-definitions/{pipeline_definition_id}

Delete pipeline definition

GET

/owner/{ownerID}/context/{context}/decision/{decisionID}/policy-bundle

Retrieves Policy Bundle for a given decision log ID

DELETE

/organization/{org-slug-or-id}/url-orb-allow-list/{allow-list-entry-id}

Remove an entry from the org's URL orb allow-list

GET

/projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers

List pipeline definition triggers

POST

/projects/{project_id}/pipeline-definitions/{pipeline_definition_id}/triggers

Create trigger

Endpoints

CircleCI API

Endpoints

CircleCI API

Endpoints

CircleCI API

Endpoints