Thanks to visit codestin.com
Credit goes to docs.stackone.com

Skip to main content
CircleCI
CircleCI
82 actions · 1 auth method

Authentication

Personal API Token

Connect your CircleCI account using a Personal API Token generated from the CircleCI web application.Guides: Connector Profile, Link Account
Actions
82 actions
Action
Description
Get Current User
Get current authenticated user info
Get User
Get a user by ID
List Collaborations
List organizations the current user is a member of, including their org IDs and slugs. ALWAYS call this first before any…
List Pipelines
Get a list of pipelines across ALL recently built projects in an organization (org-wide view, up to 250 projects). If yo…
List Project Pipelines
Get all pipelines for a SPECIFIC project by its project-slug. Use this instead of list_pipelines when you want pipelines…
Trigger Pipeline
Trigger a new pipeline for a project
Get Pipeline
Get a pipeline by ID
Get Pipeline Configuration
Get the configuration for a pipeline
Get Pipeline Workflows
Get all workflows for a pipeline
Trigger Pipeline Run
Trigger a new pipeline run from a pipeline definition
Get Pipeline By Number
Get a pipeline by its pipeline number for a given project. Get the project-slug from the project_slug field in list_pipe…
Get Pipeline Values
Get pipeline values for a pipeline
List My Pipelines
Get all pipelines triggered by the current user for a project
Continue Pipeline
Continue a pipeline from the setup phase
List Contexts
List all contexts for an owner (organization). Use owner-id (UUID) OR owner-slug (format “gh/org-name” for GitHub, “circ…
Create Context
Create a new context
Get Context
Get a context by ID
List Context Environment Variables
List environment variables in a context
Add Or Update Context Environment Variable
Add or update an environment variable in a context
Delete Context Environment Variable
Remove an environment variable from a context
Delete Context
Delete a context
Create Context Restriction
Create a project or expression restriction on a context to control which projects can use it. Returns 409 Conflict if th…
Get Context Restrictions
Get a list of restrictions associated with a context
Delete Context Restriction
Delete a restriction from a context
Get Organization
Get an organization by slug or ID
Create Organization
Create a new organization
List Orb Allow-List Entries
List entries in an organization’s URL Orb allow-list
Create Orb Allow-List Entry
Create a new URL Orb allow-list entry
Delete Organization
Delete an organization
Delete Orb Allow-List Entry
Remove an entry from the org’s URL orb allow-list
List Webhooks
List outbound webhooks for a scope
Create Webhook
Create an outbound webhook
Get Webhook
Get a webhook by ID
Update Webhook
Update an outbound webhook
Delete Webhook
Delete an outbound webhook
Get Project Workflow Runs
Get recent runs of a workflow
Get All Branches
Get all branches for a project
Get Organization Summary Metrics
Get aggregated summary metrics for an organization, including success rates, duration, and throughput across all project…
Get Project Workflow Metrics
Get summary metrics for a project’s workflows
Get Flaky Tests
Get flaky tests for a project
Get Project Workflow Summary
Get summary metrics and trends for a project across its workflows and branches
Get Job Timeseries Data
Get timeseries data for all jobs within a workflow
Create Project
Create a new project
Get Project
Get a project by its project-slug (format “vcs-slug/org-name/repo-name”). Returns 404 if the project does not exist. IMP…
Get Project Settings
Get advanced settings for a project. The provider/organization/project path params are the three segments of the project…
Update Project Settings
Update advanced settings for a project. The provider/organization/project path params are the three segments of the proj…
List Checkout Keys
Get all checkout keys for a project
Create Checkout Key
Create a new checkout key for a project
List Project Environment Variables
List all environment variables for a project
Create Project Environment Variable
Create an environment variable for a project
Get Project Environment Variable
Get a masked environment variable by name
Delete Project Environment Variable
Delete an environment variable from a project
Get Workflow
Get a workflow by ID
Get Workflow Jobs
Get all jobs for a workflow
Approve Job
Approve a pending approval job in a workflow
Cancel Workflow
Cancel a running workflow
Rerun Workflow
Rerun a workflow
Get Job Details
Get job details by job number
Cancel Job
Cancel a job by job number
Cancel Job By ID
Cancel a job by its unique ID
Get Job Artifacts
Get artifacts for a job
Get Job Test Metadata
Get test metadata for a job
Get Job
Get a job by ID
List Schedules
List schedule triggers for a project
Create Schedule
Create a pipeline schedule for a project
Get Schedule
Get a schedule by ID
Update Schedule
Update a pipeline schedule
Delete Schedule
Delete a schedule
List Pipeline Definitions
List all pipeline definitions for a project
Get Pipeline Definition
Get details for a pipeline definition
Create Pipeline Definition
Create a pipeline definition for a project. The config_source.provider must match the project’s actual integration type…
Update Pipeline Definition
Update an existing pipeline definition’s name, config file path, or checkout source. You cannot change the provider type…
Delete Pipeline Definition
Delete a pipeline definition
List Environments
List environments for an organization
Get Environment
Get an environment by ID
List Components
List components for an organization
Get Component
Get a component by ID
List Component Versions
List versions for a component
List Groups
Get all groups in an organization
Create Group
Create a new group in an organization
Get Group
Get details for a group in an organization
Delete Group
Delete a group in an organization

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/circleci/filled/png

Connector Profile

CircleCI - Personal API Token
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/circleci/filled/png

Link Account

CircleCI - Personal API Token
4

Use Actions

Invoke actions using one of the methods below: