circleci.com

The CircleCI API is a RESTful, fully-featured API that allows you to do almost anything in CircleCI. You can access all information and trigger all actions. The only thing we don’t provide access to is billing functions, which must be done from the CircleCI web UI.

🔑 apikey 22 endpoints developer_tools

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (8 total)

circleci-config-parser-ts ✓ Official

npm install circleci-config-parser-ts

GitHub integration →

circleci-config-sdk-ts ✓ Official

npm install circleci-config-sdk-ts

GitHub integration →

circleci-v2-sdk

npm install circleci-v2-sdk

GitHub integration →

circleci-node

npm install circleci-node

GitHub integration →

circleci-go

go get github.com/swissknife/circleci-go

GitHub integration →

flutter-orb ✓ Official

# See https://github.com/CircleCI-Public/flutter-orb

GitHub integration →

android-sdk ✓ Official

# See https://github.com/circleci/android-sdk

GitHub integration →

config-preview-sdk ✓ Official

# See https://github.com/CircleCI-Public/config-preview-sdk

GitHub integration →

curl examples

Provides information about the signed in user.

curl \
  # append ?circle-token=$API_KEY to the URL \
  https://circleci.com/api/v1/me

List of all the projects you're following on CircleCI, with build information…

curl \
  # append ?circle-token=$API_KEY to the URL \
  https://circleci.com/api/v1/projects

Build summary for each of the last 30 recent builds, ordered by build_num.

curl \
  # append ?circle-token=$API_KEY to the URL \
  https://circleci.com/api/v1/recent-builds

Endpoints (22 total)

GET

/me

Provides information about the signed in user.

GET

/projects

List of all the projects you're following on CircleCI, with build information…

GET

/recent-builds

Build summary for each of the last 30 recent builds, ordered by build_num.

GET

/project/{username}/{project}

Build summary for each of the last 30 builds for a single git repo.

GET

/project/{username}/{project}/envvar

Lists the environment variables for :project

GET

/project/{username}/{project}/{build_num}

Full details for a single build. The response includes all of the fields from…

GET

/project/{username}/{project}/checkout-key

Lists checkout keys.

GET

/project/{username}/{project}/envvar/{name}

Gets the hidden value of environment variable :name

GET

/project/{username}/{project}/{build_num}/tests

Provides test metadata for a build Note: [Learn how to set up your builds to …

GET

/project/{username}/{project}/{build_num}/artifacts

List the artifacts produced by a given build.

GET

/project/{username}/{project}/checkout-key/{fingerprint}

Get a checkout key.

POST

/user/heroku-key

Adds your Heroku API key to CircleCI, takes apikey as form param name.

Related APIs in same category

apideck.com apideck.com apideck.com apideck.com apideck.com apideck.com