Icon

CircleCI (version v2.*.*)

Circle CI integration

delete_project_build_cache

Clears the cache for a project.

Parameters

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

delete_project_checkout_key_by_fingerprint

Delete a checkout key.

Parameters

fingerprint (required)

XXXXXXXXXX

Type: string

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

delete_project_envvar_by_name

Deletes the environment variable named ':name'

Parameters

name (required)

XXXXXXXXXX

Type: string

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_me

This operation has no parameters

get_project_artifacts

List the artifacts produced by a given build.

Parameters

build_num (required)

XXXXXXXXXX

Type: integer

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_project_by_build_num

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

Parameters

build_num (required)

XXXXXXXXXX

Type: integer

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_project_by_project

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

Parameters

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

filter

Restricts which builds are returned.
Set to "completed", "successful", "failed", "running", or defaults to no filter.

Type: string

Potential values: completed, successful, failed, running

get_project_checkout_key

Lists checkout keys.

Parameters

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_project_checkout_key_by_fingerprint

Get a checkout key.

Parameters

fingerprint (required)

XXXXXXXXXX

Type: string

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_project_envvar

Lists the environment variables for :project

Parameters

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_project_envvar_by_name

Gets the hidden value of environment variable :name

Parameters

name (required)

XXXXXXXXXX

Type: string

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_project_tests

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

Parameters

build_num (required)

XXXXXXXXXX

Type: integer

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

get_projects

This operation has no parameters

get_recent_builds

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

This operation has no parameters

post_project_by_project

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

Parameters

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

$body

Type: object

{
"parallel" : "The number of containers to use to run the build. Default is null and the project default is used.\n",
"tag" : "The tag to build. Default is null. Cannot be used with revision parameter.\n",
"build_parameters" : { },
"revision" : "The specific revision to build.\nDefault is null and the head of the branch is used. Cannot be used with tag parameter.\n"
}

post_project_cancel

Cancels the build, returns a summary of the build.

Parameters

build_num (required)

XXXXXXXXXX

Type: integer

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

post_project_checkout_key

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

Parameters

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

$body

The type of key to create. Can be 'deploy-key' or 'github-user-key'.

Type: string

Potential values: deploy-key, github-user-key

post_project_envvar

Creates a new environment variable

Parameters

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

post_project_retry

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

Parameters

build_num (required)

XXXXXXXXXX

Type: integer

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

post_project_ssh_key

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

Parameters

Content-Type (required)

Type: string

Potential values: application/json

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

$body

Type: object

{
"hostname" : "string",
"private_key" : "string"
}

post_project_tree_by_branch

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 using parameterized builds

Parameters

branch (required)

The branch name should be url-encoded.

Type: string

project (required)

XXXXXXXXX

Type: string

username (required)

The GitHub or Bitbucket project account username for the target project

Type: string

vcstype (required)

What version control system type your project uses. Current choices are ‘github’ or ‘bitbucket’.

Type: string

$body

Type: object

{
"parallel" : "The number of containers to use to run the build. Default is null and the project default is used.\n",
"build_parameters" : { },
"revision" : "The specific revision to build.\nDefault is null and the head of the branch is used. Cannot be used with tag parameter.\n"
}

post_user_heroku_key

This operation has no parameters