Schedule a pipeline execution

POST /pipelines/schedule

This will create a job for execution of the specified pipeline and variables. If the pipeline is not schedulable (running and no queue / limit or concurrency exceeded) it will error.

Body

pipeline string Required

Pipeline name
variables object

Job variables
Hide variables attribute Show variables attribute object
- Additional properties: object

Responses

400
Hide response attribute Show response attribute object
- error string
  
  Error message
default
Hide response attribute Show response attribute object
- jobId string(uuid4)
  
  Id of the scheduled job

POST /pipelines/schedule

curl \
 -X POST http://localhost:8080/pipelines/schedule \
 -d '{"pipeline":"my_pipeline","variables":{"databases":["mysql","postgresql"],"tag_name":"v1.17.4"}}'

Request example

{
  "pipeline": "my_pipeline",
  "variables": {
    "databases": [
      "mysql",
      "postgresql"
    ],
    "tag_name": "v1.17.4"
  }
}

Request examples

{
  "pipeline": "my_pipeline",
  "variables": {
    "tag_name": "v1.17.4",
    "databases": [
      "mysql",
      "postgresql"
    ]
  }
}

Response examples (400)

{
  "error": "string"
}

Response examples (400)

{
  "error": "string"
}

Response examples (default)

{
  "jobId": "string"
}

Response examples (default)

{
  "jobId": "string"
}