CircleCI API

by circleci.com

Overview

Automate the software development process using continuous integration and continuous delivery

CircleCI is a continuous integration API from circleci.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 22 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Continuous Integration
Base URL: https://circleci.com/api/v1
Version: v1
Endpoints: 22
OpenAPI: Specification ↗
Spec updated: 2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://circleci.com/api/v1/me" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://circleci.com/api/v1/me", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://circleci.com/api/v1/me",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/me`	Provides information about the signed in user.
GET	`/project/{username}/{project}`	Build summary for each of the last 30 builds for a single git repo.
POST	`/project/{username}/{project}`	Triggers a new build, returns a summary of the build.
DELETE	`/project/{username}/{project}/build-cache`	Clears the cache for a project.
GET	`/project/{username}/{project}/checkout-key`	Lists checkout keys.
POST	`/project/{username}/{project}/checkout-key`	Creates a new checkout key.
GET	`/project/{username}/{project}/checkout-key/{fingerprint}`	Get a checkout key.
DELETE	`/project/{username}/{project}/checkout-key/{fingerprint}`	Delete a checkout key.
GET	`/project/{username}/{project}/envvar`	Lists the environment variables for :project
POST	`/project/{username}/{project}/envvar`	Creates a new environment variable
GET	`/project/{username}/{project}/envvar/{name}`	Gets the hidden value of environment variable :name
DELETE	`/project/{username}/{project}/envvar/{name}`	Deletes the environment variable named ':name'
POST	`/project/{username}/{project}/ssh-key`	Create an ssh key used to access external systems that require SSH key-based authentication
POST	`/project/{username}/{project}/tree/{branch}`	Triggers a new build, returns a summary of the build.
GET	`/project/{username}/{project}/{build_num}`	Full details for a single build. The response includes all of the fields from the build summary.
GET	`/project/{username}/{project}/{build_num}/artifacts`	List the artifacts produced by a given build.
POST	`/project/{username}/{project}/{build_num}/cancel`	Cancels the build, returns a summary of the build.
POST	`/project/{username}/{project}/{build_num}/retry`	Retries the build, returns a summary of the new build.
GET	`/project/{username}/{project}/{build_num}/tests`	Provides test metadata for a build
GET	`/projects`	List of all the projects you're following on CircleCI, with build information organized by branch.
GET	`/recent-builds`	Build summary for each of the last 30 recent builds, ordered by build_num.
POST	`/user/heroku-key`	Adds your Heroku API key to CircleCI, takes apikey as form param name.