CircleCI REST API

OpenAPI apis-guru developer_tools

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.

Homepage: https://api.apis.guru/v2/specs/circleci.com/v1.json
Provider: circleci.com
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/circleci.com/v1/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/circleci.com/v1/openapi.yaml

Tools (24)

Extracted live via the executor SDK.

me.getMe

Provides information about the signed in user.
project.deleteProjectUsernameProjectBuildCache

Clears the cache for a project.
project.deleteProjectUsernameProjectCheckoutKeyFingerprint

Delete a checkout key.
project.deleteProjectUsernameProjectEnvvarName

Deletes the environment variable named ':name'
project.getProjectUsernameProject

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

Full details for a single build. The response includes all of the fields from the build summary. This is also the payload for the , in which case this object is the value to a key named 'payload'.
project.getProjectUsernameProjectBuildNumArtifacts

List the artifacts produced by a given build.
project.getProjectUsernameProjectBuildNumTests

Provides test metadata for a build Note:
project.getProjectUsernameProjectCheckoutKey

Lists checkout keys.
project.getProjectUsernameProjectCheckoutKeyFingerprint

Get a checkout key.
project.getProjectUsernameProjectEnvvar

Lists the environment variables for :project
project.getProjectUsernameProjectEnvvarName

Gets the hidden value of environment variable :name
project.postProjectUsernameProject

Triggers a new build, returns a summary of the build.
project.postProjectUsernameProjectBuildNumCancel

Cancels the build, returns a summary of the build.
project.postProjectUsernameProjectBuildNumRetry

Retries the build, returns a summary of the new build.
project.postProjectUsernameProjectCheckoutKey

Creates a new checkout key. Only usable with a user API token.
project.postProjectUsernameProjectEnvvar

Creates a new environment variable
project.postProjectUsernameProjectSshKey

Create an ssh key used to access external systems that require SSH key-based authentication
project.postProjectUsernameProjectTreeBranch

Triggers a new build, returns a summary of the build. Optional build parameters can be set using an experimental API.
Note: For more about build parameters, read about
projects.getProjects

List of all the projects you're following on CircleCI, with build information organized by branch.
recentBuilds.getRecentBuilds

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

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

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools