Triggers
Job completed
Triggered when a job is completed.
Workflow completed
Triggered when a workflow is completed
Actions
Add or update an environment variable context
Create or update an environment variable within a context. Returns information about the environment variable, not including its value.
Approve a job workflow
Approves a pending approval job in a workflow.
Cancel a workflow
Cancels a running workflow.
Cancel job
Cancel job with a given job number.
Collaborations
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
Continue a pipeline
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.
Create a new context
Creates a new context.
Create a schedule
Not yet available to projects that use GitLab or GitHub App. Creates a schedule and returns the created schedule.
Create an environment variable envvar
Creates a new environment variable.
Create an outbound webhook
Creates an outbound webhook.
Delete a context
This integration action is generated from CircleCI API API's OAS definition.
Delete a schedule
Not yet available to projects that use GitLab or GitHub App. Deletes the schedule by id.
Delete an environment variable project
Deletes the environment variable named :name.
Delete an outbound webhook
Deletes an outbound webhook
Get a context
Returns basic information about a context.
Get a list of pipelines
Returns all pipelines for the most recently built projects (max 250) you follow in an organization.
Get a masked environment variable project
Returns the masked value of environment variable :name.
Get a pipeline by ID
Returns a pipeline by the pipeline ID.
Get a pipeline by pipeline number project
Returns a pipeline by the pipeline number.
Get a pipeline's configuration
Returns a pipeline's configuration by ID.
Get a pipeline's workflows
Returns a paginated list of workflows by pipeline ID.
Get a project
Retrieves a project by project slug.
Get a schedule
Get a schedule by id.
Get a webhook
Get an outbound webhook by id.
Get a workflow
Returns summary fields of a workflow by ID.
Get a workflow's jobs
Returns a sequence of jobs for a workflow.
Get all branches for a project
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.
Get all pipelines
Returns all pipelines for this project.
Get all schedules
Returns all schedules for this project.
Get job details project
Returns job details.
Get metrics and trends for workflows summary
Get the metrics and trends for a particular workflow on a single branch or all branches
Get recent runs of a workflow insights
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.
Get summary metrics and trends for a project across it's workflows and branches
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.
Get summary metrics for a project workflow's jobs.
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.
Get summary metrics for a project's workflows
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.
Get summary metrics with trends for the entire org, and for each project.
Gets aggregated summary metrics with trends for the entire org. Also gets aggregated metrics and trends for each project belonging to the org.
Get test metadata
Get test metadata for a build. In the rare case where there is more than 250MB of test data on the job, no results will be returned.
Get test metrics for a project's workflows
Get test metrics for a project's workflows. Currently tests metrics are calculated based on 10 most recent workflow runs.
Get your pipelines mine
Returns a sequence of all pipelines for this project triggered by the user.
Job timeseries data
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.
List all environment variables envvar
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.
List contexts
List all contexts for an owner.
List environment variables
List information about environment variables in a context, not including their values.
List webhooks
Get a list of outbound webhooks that match the given scope-type and scope-id
Makes a decision
This endpoint will evaluate input data (config+metadata) against owner's stored policies and return a decision.
Remove an environment variable context
Delete an environment variable from a context.
Rerun a workflow
Reruns a workflow.
Trigger a new pipeline
Not yet available to projects that use GitLab or GitHub App. Triggers a new pipeline on the project.
Trigger a pipeline with inbound trigger
Triggers a pipeline via inbound trigger. To configure inbound trigger visit: https://circleci.com/docs/triggers-overview/#trigger-a-pipeline-from-an-inbound-webhook
Update a schedule
Not yet available to projects that use GitLab or GitHub App. Updates a schedule and returns the updated schedule.
Update an outbound webhook
Updates an outbound webhook.
User Information
Provides information about the user that is currently signed in.
