v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Schedules

Create a new schedule

Create a new schedule for a specific project, pipeline and environment

post/v1/projects/{projectId}/schedules

Path parameters

projectIdstring uuid required

Request body

Example request

{
  "pipeline": {
    "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "environmentName": "Dev Env",
    "pipelineName": "My pipeline",
    "versionName": "1.1.0"
  },
  "schedule": {
    "cronExpression": "0 * * ? * * *",
    "cronTimezone": "Europe/Dublin",
    "effectiveFrom": "2022-05-19T11:37:44.024Z",
    "name": "Nightly database backup"
  }
}

Response

Schedule created

scheduleIdstring

The generated unique schedule Id used to identify a specific schedule

Example response

{
  "scheduleId": "a2239897-51f8-4c09-83ab-0b2c28bd5a37"
}