mocop
Browse · Docs · Guide · Analyze

CircleCI API

API by CircleCI · rest

This describes the resources that make up the CircleCI API v2. --- New to the CircleCI API? Start with the [V3 API](https://circleci.com/docs/api/v3/index.html) - it's where new capabilities are landing, with clearer conventions than v2. This document covers v2, which remains supported.

Endpoint: https://circleci.com/api/v2

Verification: observed. Source: crawl.

Capabilities (112)

  • List contexts
  • Create a new context
  • Get a context
  • Delete a context
  • List environment variables
  • Add or update an environment variable
  • Remove an environment variable
  • Get context restrictions
  • Create context restriction
  • Delete context restriction
  • List Components
  • Get Component
  • List Component Versions
  • List Environments
  • Get Environment
  • Get summary metrics and trends for a project across it's workflows and branches
  • Get summary metrics and trends for a project across its workflows and…
  • Job timeseries data
  • Get summary metrics with trends for the entire org and for each project.
  • Get all branches for a project
  • Get flaky tests for a project
  • Get summary metrics for a project's workflows
  • Get recent runs of a workflow
  • Get summary metrics for a project workflow's jobs.
  • Get metrics and trends for workflows
About · Contact · Privacy