Pipeline schedules
Pipeline schedule object
{
"created_at": "2023-03-01 20:27:23.645692+00:00",
"event_matchers": [],
"id": 41,
"last_pipeline_run_status": null,
"name": "dark brook",
"pipeline_runs_count": 0,
"pipeline_uuid": "dry_bird",
"schedule_interval": "@once",
"schedule_type": "time",
"settings": {
"allow_blocks_to_fail": true,
"skip_if_previous_running": false
},
"sla": 950400,
"start_time": "2023-03-01 22:04:00+00:00",
"status": "inactive",
"token": "1dca215c01564d48bf0d3db7d5450a20",
"updated_at": "2023-03-01 22:04:29.761238+00:00",
"variables": {
"env": "dev"
}
}
Date and time the trigger was created.
Event matching logic for event triggers.
Trigger ID.
Name of trigger.
Pipeline UUID the trigger belongs to.
@once
, @hourly
, @daily
, @weekly
, @monthly
Trigger type: api
, event
, time
Additional settings for the trigger.
If true
, then blocks in the pipeline will continue to run even if unrelated blocks fail.
If true
, then new pipeline runs won’t be triggered until the most recent pipeline run is
no longer running.
If the pipeline run has been running for more than the SLA value, then the pipeline will fail.
Date and time when the trigger should start running.
active
, inactive
Unique string used in the URL when triggering pipeline via API request.
Date and time the trigger was last updated.
Object containing variables for the pipeline that is being overwritten by this trigger.
The property name is user defined.
Read all pipeline schedules
GET /api/pipelines/:pipeline_uuid/pipeline_schedules
Pipeline UUID that the pipeline schedules should all belong to.
curl --request GET \
--url 'http://localhost:6789/api/pipelines/:pipeline_uuid/pipeline_schedules?api_key=zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2' \
--header 'Authorization: Bearer ZKXScwLKLZUujbw7vwMeWnhtTTSLqifw8_RnBHYipww' \
{
"pipeline_schedules": [
{
"id": 42,
"created_at": "2023-03-01 22:04:33.609624+00:00",
"updated_at": "2023-03-01 22:04:35.163834+00:00",
"name": "dry darkness",
"pipeline_uuid": "dry_bird",
"schedule_type": "time",
"start_time": "2023-03-01 22:04:00+00:00",
"schedule_interval": "@hourly",
"status": "inactive",
"variables": null,
"sla": null,
"token": "f176321c4eac425782236acd0eb9886d",
"settings": {},
"event_matchers": [],
"last_pipeline_run_status": null,
"pipeline_runs_count": 0
},
{
"id": 41,
"created_at": "2023-03-01 20:27:23.645692+00:00",
"updated_at": "2023-03-31 05:15:51.171762+00:00",
"name": "dark brook",
"pipeline_uuid": "dry_bird",
"schedule_type": "time",
"start_time": "2023-03-01 22:04:00+00:00",
"schedule_interval": "@once",
"status": "inactive",
"variables": {
"env": "dev2"
},
"sla": 950400,
"token": "1dca215c01564d48bf0d3db7d5450a20",
"settings": {
"skip_if_previous_running": true,
"allow_blocks_to_fail": true
},
"event_matchers": [],
"last_pipeline_run_status": null,
"pipeline_runs_count": 0
}
],
"metadata": {
"count": 3,
"next": false
}
}
Create pipeline schedule
WIP
Read pipeline schedule
WIP
Update pipeline schedule
PUT /api/pipeline_schedules/:id
Pipeline schedule ID
curl --request PUT \
--url 'http://localhost:6789/api/pipeline_schedules/55?api_key=zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2' \
--header 'Authorization: Bearer ZKXScwLKLZUujbw7vwMeWnhtTTSLqifw8_RnBHYipww' \
--data '{
"pipeline_schedule": {
"name": "black voice11111",
"schedule_type": "time",
"event_matchers": [],
"schedule_interval": "@once",
"start_time": "2023-03-06 04:53:00",
"variables": {
"env": "dev112222",
"test": 11111
},
"sla": 1000,
"settings": {
"skip_if_previous_running": true,
"allow_blocks_to_fail": true
}
}
}'
{
"pipeline_schedule": {
"id": 55,
"created_at": "2023-03-08 04:52:54.268096+00:00",
"updated_at": "2023-04-01 00:52:11.753497+00:00",
"name": "black voice11111",
"pipeline_uuid": "example_pipeline",
"schedule_type": "time",
"start_time": "2023-03-06 04:53:00+00:00",
"schedule_interval": "@once",
"status": "inactive",
"variables": {
"env": "dev112222",
"test": 11111
},
"sla": 1000,
"token": "67d62ed3e66143839f58945bb7d16387",
"settings": {
"skip_if_previous_running": true,
"allow_blocks_to_fail": true
},
"event_matchers": []
}
}
Delete pipeline schedule
WIP