Explore 11 workflow actions for CircleCI, including account permissions and operation limits.
6 read actions5 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Cancel job
Write
Request cancellation of a specific job by its stable ID.
Permissions and limits
Account permissions
Cancel the selected job
Operation limits
The provider message confirms request acceptance. Read the job again to confirm its final status.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel workflow
Write
Request cancellation of a specific workflow.
Permissions and limits
Account permissions
Cancel the selected workflow
Operation limits
The provider message confirms request acceptance. Read the workflow again to confirm its final status.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get job
Read
Read a job by its stable ID without retrieving build logs.
Permissions and limits
Account permissions
Read the selected job
Operation limits
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
Get pipeline
Read
Read the provider-reported state of a specific pipeline.
Permissions and limits
Account permissions
Read the selected pipeline
Operation limits
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
Get workflow
Read
Read one workflow and its pipeline relationship.
Permissions and limits
Account permissions
Read the selected workflow
Operation limits
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
List pipeline workflows
Read
Read the workflows belonging to a selected pipeline.
Permissions and limits
Account permissions
Read the selected pipeline
Operation limits
Returns one page. Pass next_page_token as pageToken until it is null or empty.
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
Pagination: cursor. Check the result for additional pages; a single action may not return every record.
List project pipelines
Read
Read pipeline summaries for a specific project and optional branch.
Permissions and limits
Account permissions
Read the selected project
Operation limits
Returns one page. Pass next_page_token as pageToken until it is null or empty.
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
Pagination: cursor. Check the result for additional pages; a single action may not return every record.
List workflow jobs
Read
Read build and approval job summaries within a workflow.
Permissions and limits
Account permissions
Read the selected workflow jobs
Operation limits
Returns one page. Pass next_page_token as pageToken until it is null or empty.
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
Pagination: cursor. Check the result for additional pages; a single action may not return every record.
Rerun workflow
Write
Rerun an entire workflow or continue from failed jobs.
Permissions and limits
Account permissions
Rerun the selected workflow
Operation limits
Returns the new workflow ID. Job selection, sparse reruns and SSH access are not enabled by this operation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Trigger pipeline
Write
Run an explicit pipeline definition with typed parameters and selected refs.
Permissions and limits
Account permissions
Trigger the selected project pipeline
Operation limits
Requires a pipeline definition ID from Project Settings. GitLab is not supported by this trigger endpoint. A receipt means accepted, not build success. Config and checkout accept either branch or tag. Parameters are not secret storage.
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Trigger pipeline by branch or tag
Write
Start a pipeline on a branch or tag with pipeline parameters, using the project's configured pipeline.
Permissions and limits
Account permissions
Trigger the selected project pipeline
Operation limits
CircleCI documents this endpoint as superseded by the definition-based trigger; it does not support GitLab or GitHub App projects. A receipt means accepted, not build success. Parameters are not secret storage.
Returns typed execution summaries, excluding configuration files, environment variables, trigger parameters, user records and build output.
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in CircleCI. A saved workflow is not a completed provider action.
Cloud & Infrastructure · CONNECTION
