CircleCI

CircleCI is a continuous integration and delivery platform that automates software building, testing, and deployment. This repository is an alias of the primary `circleci` index and is preserved so historical references and links continue to resolve. The full set of REST, runner, webhook, and orbs APIs is profiled in the `circleci` repository at https://github.com/api-evangelist/circleci.

3 APIs 0 Features

CI/CDContinuous DeploymentContinuous IntegrationDevOpsPipelinesWorkflows

APIs

CircleCI REST API V2

The CircleCI REST API v2 provides programmatic access for managing pipelines, projects, workflows, jobs, contexts, and users.

CircleCI Self-Hosted Runner API

The CircleCI Runner API is used for the management and execution of self-hosted runner jobs.

CircleCI Webhooks

Real-time event notifications for pipeline, workflow, and job lifecycle events delivered via HTTP callbacks.

Collections

CircleCI REST API V2

OPEN

Pricing Plans

Circlecis Plans Pricing

3 plans

PLANS

Rate Limits

Circlecis Rate Limits

5 limits

RATE LIMITS

FinOps

Circlecis Finops

FINOPS

Resources

Canonical Profile

Sources

opencollection: 1.0.0
info:
  name: CircleCI REST API V2
  version: 2.0.0
request:
  auth:
    type: apikey
    key: Circle-Token
    value: '{{Circle-Token}}'
    placement: header
items:
- info:
    name: Context
    type: folder
  items:
  - info:
      name: List contexts
      type: http
    http:
      method: GET
      url: https://circleci.com/api/v2/context
      params:
      - name: owner-id
        value: ''
        type: query
      - name: page-token
        value: ''
        type: query
    docs: List all contexts for an owner.
  - info:
      name: Create a context
      type: http
    http:
      method: POST
      url: https://circleci.com/api/v2/context
      body:
        type: json
        data: '{}'
    docs: Creates a new context in the specified organization.
- info:
    name: Pipeline
    type: folder
  items:
  - info:
      name: Continue a pipeline
      type: http
    http:
      method: POST
      url: https://circleci.com/api/v2/pipeline/continue
      body:
        type: json
        data: '{}'
    docs: Continue a pipeline from the setup phase.
  - info:
      name: Get pipeline by ID
      type: http
    http:
      method: GET
      url: https://circleci.com/api/v2/pipeline/:pipeline-id
      params:
      - name: pipeline-id
        value: ''
        type: path
    docs: Retrieve pipeline details by unique identifier.
- info:
    name: Project
    type: folder
  items:
  - info:
      name: Trigger a new pipeline
      type: http
    http:
      method: POST
      url: https://circleci.com/api/v2/project/:project-slug/pipeline
      params:
      - name: project-slug
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Trigger a new pipeline on a project.
- info:
    name: Job
    type: folder
  items:
  - info:
      name: Get job by number
      type: http
    http:
      method: GET
      url: https://circleci.com/api/v2/project/:project-slug/job/:job-number
      params:
      - name: project-slug
        value: ''
        type: path
      - name: job-number
        value: ''
        type: path
    docs: Retrieve job details and metadata.
  - info:
      name: Cancel a job
      type: http
    http:
      method: POST
      url: https://circleci.com/api/v2/jobs/:job-id/cancel
      params:
      - name: job-id
        value: ''
        type: path
    docs: Cancel a job by its unique ID.
- info:
    name: Workflow
    type: folder
  items:
  - info:
      name: Cancel a workflow
      type: http
    http:
      method: POST
      url: https://circleci.com/api/v2/workflow/:id/cancel
      params:
      - name: id
        value: ''
        type: path
    docs: Cancels a running workflow.
- info:
    name: User
    type: folder
  items:
  - info:
      name: Get current user
      type: http
    http:
      method: GET
      url: https://circleci.com/api/v2/me
    docs: Provides information about the user that is currently signed in.
bundled: true