Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1411163326.7 KB
Pipeline Definition

Update pipeline definition

Update pipeline definition. Currently only supported for pipeline definitions where config_source.provider is github_app, github_server, or bitbucket_dc. Share feedback about our Project Administration APIs.

patch/projects/{project_id}/pipeline-definitions/{pipeline_definition_id}

Path parameters

project_idstring required

An opaque identifier of a project.

pipeline_definition_idstring required

An opaque identifier of a pipeline definition.

Request body

namestring

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": {
    "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"
    }
  }
}