Pipeline Definition

Create pipeline definition

Create a pipeline definition for a given project. Currently only supported for pipeline definitions where config_source.provider is github_app or github_server. Share feedback about our Project Administration APIs.

post/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.

Request body

namestring required

The name of the pipeline definition.

descriptionstring

The description of the pipeline definition.

Example request

{
  "name": "Some pipeline name",
  "description": "Some pipeline description",
  "config_source": {
    "provider": "github_app",
    "repo": {
      "external_id": "some-repo-id"
    },
    "file_path": ".circleci/some-pipeline.yml"
  },
  "checkout_source": {
    "provider": "github_app",
    "repo": {
      "external_id": "some-repo-id"
    }
  }
}

Response

Successful response.

idstring uuid

The unique ID of the pipeline definition.

namestring

The name of the pipeline definition.

descriptionstring

The description of the pipeline definition.

created_atstring date-time

The date and time the pipeline definition was created.

Example response

{
  "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.