Pipeline Definition

List pipeline definitions

List all pipeline definitions for a given project. Share feedback about our Project Administration APIs.

get/projects/{project_id}/pipeline-definitions

Request

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

Path parameters

project_idstring required

An opaque identifier of a project.

Response

Successful response.

Example response

{
  "items": [
    {
      "name": "some pipeline",
      "description": "some pipeline description",
      "config_source": {
        "provider": "github_app",
        "repo": {
          "full_name": "some-org/some-repo-name",
          "external_id": "some-repo-id"
        },
        "file_path": ".circleci/some-pipeline.yml"
      },
      "checkout_source": {
        "provider": "github_app",
        "repo": {
          "full_name": "some-org/some-repo-name",
          "external_id": "some-repo-id"
        }
      }
    }
  ]
}

Changes

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