Pipeline

Get a pipeline by pipeline number

Returns a pipeline by the pipeline number.

get/project/{project-slug}/pipeline/{pipeline-number}

Request

Base URL
https://circleci.com/api/v2
URL
https://circleci.com/api/v2/project/{project-slug}/pipeline/{pipeline-number}
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).

pipeline-numberunknown required

The number of the pipeline.

Response

A pipeline object.

idstring uuid required

The unique ID of the pipeline.

project_slugstring required

The project-slug for the pipeline.

updated_atstring date-time

The date and time the pipeline was last updated.

numberinteger required

The number of the pipeline.

trigger_parametersobject

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

The current state of the pipeline.

created_atstring date-time required

The date and time the pipeline was created.

Example response

{
  "id": "5034460f-c7c4-4c43-9457-de07e2029e7b",
  "project_slug": "gh/CircleCI-Public/api-preview-docs",
  "number": 25,
  "vcs": {
    "provider_name": "GitHub",
    "target_repository_url": "https://github.com/CircleCI-Public/api-preview-docs",
    "branch": "feature/design-new-api",
    "review_id": "123",
    "review_url": "https://github.com/CircleCI-Public/api-preview-docs/pull/123",
    "revision": "f454a02b5d10fcccfd7d9dd7608a76d6493a98b4",
    "tag": "v3.1.4159",
    "origin_repository_url": "https://github.com/CircleCI-Public/api-preview-docs"
  }
}

Changes

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