v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Schedules

List All Schedules for a Project

An endpoint for listing schedules for a project

get/v1/projects/{projectId}/schedules

Path parameters

projectIdstring uuid required

Query parameters

{"stackTrail":"paths:/v1/projects/{projectId}/schedules:get:parameters:1:schema","oasType":"schema","type":"unknown"}

Page number (0-indexed)

{"stackTrail":"paths:/v1/projects/{projectId}/schedules:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Number of records per page (from 1 to 100)

Response

Schedules returned successfully with no errors

pageinteger

The 0-indexed page number of the returned results.

sizeinteger

The size of each page of results.

totalinteger

Total number of available results across all pages.

Example response

{
  "page": 1,
  "results": [
    {
      "cronExpression": "0 * * ? * * *",
      "cronTimezone": "Europe/Dublin",
      "effectiveFrom": "2022-05-19T12:37:44.000Z",
      "environmentName": "Dev Environment",
      "gridVariables": {
        "grid1": [
          [
            "col1",
            "col2",
            "col3"
          ],
          [
            "col1a",
            "col2a",
            "col3a"
          ]
        ]
      },
      "lastRunAt": "2022-06-30T01:14:00.000Z",
      "name": "Nightly database backup",
      "nextRunAt": "2022-06-30T01:15:00.000Z",
      "pipelineName": "Nightly database backup",
      "scalarVariables": {
        "variable1": "value1",
        "variable2": "value2"
      },
      "scheduleId": "a2239897-51f8-4c09-83ab-0b2c28bd5a37",
      "versionName": "1.2.0"
    }
  ],
  "size": 50,
  "total": 472
}