CIcircleci
Pipeline

Trigger a new pipeline

[This endpoint is superseded by the new Trigger Pipeline API, which supports all organization and pipeline types except GitLab.] Triggers a new pipeline on the project. Does not support triggering pipelines integrated with GitLab or GitHub App.

post/project/{project-slug}/pipeline

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/project/{project-slug}/pipeline
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

project-slugstring required

Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Request body

branchstring

The branch where the pipeline ran. The HEAD commit on this branch was used for the pipeline. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull/<number>/head for the PR ref or pull/<number>/merge for the merge ref (GitHub only).

tagstring

The tag used by the pipeline. The commit that this tag points to was used for the pipeline. Note that branch and tag are mutually exclusive.

parametersobject

An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.

Example request

{
  "branch": "feature/design-new-api",
  "tag": "v3.1.4159",
  "parameters": {
    "deploy_prod": true
  }
}

Response

The created pipeline.

idstring uuid required

The unique ID of the pipeline.

state'created' | 'errored' | 'setup-pending' | 'setup' | 'pending' required

The current state of the pipeline.

numberinteger required

The number of the pipeline.

created_atstring date-time required

The date and time the pipeline was created.

Example response

{
  "id": "5034460f-c7c4-4c43-9457-de07e2029e7b",
  "number": 25
}

Changes

No recorded changes to this operation across all 1 revision of this API.