Pipeline schedules
Create pipeline schedule
Environment-specific configuration
API
- Overview
- Design
- Backfills
- Blocks
- Logs
- OAuth access tokens
- Pipeline runs
- Pipeline schedules
- Pipelines
- Sessions
Pipeline schedules
Create pipeline schedule
curl --request POST
-H 'Content-Type: application/json'
-H 'Cookie: oauth_token=some_really_long_string'
-H 'X-API-KEY: zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2'
-d '{
"pipeline_schedule": {
"name": "Example Pipeline Schedule Name",
"schedule_type": "time",
"event_matchers": [],
"schedule_interval": "@once",
"start_time": "2023-03-06 04:53:00",
"variables": {
"env": "dev112222",
"test": 11111
},
"sla": 1000,
"settings": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true
}
}
}'
--url http://localhost:6789/api/pipelines/example_pipeline/pipeline_schedules
{
"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": "Example Pipeline Schedule Name",
"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": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true
},
"event_matchers": []
}
}
POST /api/pipelines/:pipeline_uuid/pipeline_schedules
Pipeline UUID that the pipeline schedule should all belong to.
curl --request POST
-H 'Content-Type: application/json'
-H 'Cookie: oauth_token=some_really_long_string'
-H 'X-API-KEY: zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2'
-d '{
"pipeline_schedule": {
"name": "Example Pipeline Schedule Name",
"schedule_type": "time",
"event_matchers": [],
"schedule_interval": "@once",
"start_time": "2023-03-06 04:53:00",
"variables": {
"env": "dev112222",
"test": 11111
},
"sla": 1000,
"settings": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true
}
}
}'
--url http://localhost:6789/api/pipelines/example_pipeline/pipeline_schedules
{
"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": "Example Pipeline Schedule Name",
"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": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true
},
"event_matchers": []
}
}
Was this page helpful?
curl --request POST
-H 'Content-Type: application/json'
-H 'Cookie: oauth_token=some_really_long_string'
-H 'X-API-KEY: zkWlN0PkIKSN0C11CfUHUj84OT5XOJ6tDZ6bDRO2'
-d '{
"pipeline_schedule": {
"name": "Example Pipeline Schedule Name",
"schedule_type": "time",
"event_matchers": [],
"schedule_interval": "@once",
"start_time": "2023-03-06 04:53:00",
"variables": {
"env": "dev112222",
"test": 11111
},
"sla": 1000,
"settings": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true
}
}
}'
--url http://localhost:6789/api/pipelines/example_pipeline/pipeline_schedules
{
"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": "Example Pipeline Schedule Name",
"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": {
"allow_blocks_to_fail": true,
"create_initial_pipeline_run": false,
"skip_if_previous_running": true
},
"event_matchers": []
}
}