Skip to main content
POST
Create pipeline
The new pipeline is empty. Build its steps in Prophecy, then commit the changes to record the pipeline in the project’s Git history.

Headers

X-AUTH-TOKEN
string
required

Prophecy access token

Body

application/json
projectId
string
required

ID of the project to add the pipeline to. Send it as a string, in quotes.

branch
string
required

Branch to add the pipeline to. Use dev in a project that uses Simple Git.

pipelineName
string
required

Name of the pipeline. Use letters, digits, and underscores, starting with a letter or underscore. The name must be unique in the project, including pipelines in other folders.

filePath
string

Folder to place the pipeline in, in the format pipelines/{folderName}. If omitted, the pipeline goes in the project's pipelines folder.

Response

200 - application/json

Pipeline created

success
boolean

Indicates whether the pipeline was created.

message
string

Message that explains the outcome of the request.