Overview

{
  "blocks": [
    {
      "all_upstream_blocks_executed": true,
      "color": null,
      "configuration": {},
      "downstream_blocks": [],
      "executor_config": null,
      "executor_type": "local_python",
      "has_callback": null,
      "name": "load_titanic",
      "language": "python",
      "status": "executed",
      "type": "data_loader",
      "upstream_blocks": [],
      "uuid": "load_titanic",
      "content": "...",
      "metadata": {}
    }
  ],
  "description": null,
  "extensions": {},
  "name": "example_pipeline",
  "pipeline_callbacks": [
    {
      "callback_block_uuid": "notify_stakeholders",
      "enabled": true
    }
  ],
  "schedules": [
    {
      "created_at": "2023-03-14T23:24:17.814478+00:00",
      "id": 59,
      "name": "dry haze",
      "pipeline_uuid": "aged_night",
      "schedule_interval": null,
      "schedule_type": "api",
      "start_time": "2023-03-14T23:25:00+00:00",
      "status": "inactive",
      "updated_at": "2023-03-14T23:25:27.351528+00:00"
    }
  ],
  "type": "python",
  "uuid": "example_pipeline",
  "variables": {
    "env": "prod"
  },
  "widgets": []
}

Pipeline object

{
  "blocks": [
    {
      "all_upstream_blocks_executed": true,
      "color": null,
      "configuration": {},
      "downstream_blocks": [],
      "executor_config": null,
      "executor_type": "local_python",
      "has_callback": null,
      "name": "load_titanic",
      "language": "python",
      "status": "executed",
      "type": "data_loader",
      "upstream_blocks": [],
      "uuid": "load_titanic",
      "content": "...",
      "metadata": {}
    }
  ],
  "description": null,
  "extensions": {},
  "name": "example_pipeline",
  "pipeline_callbacks": [
    {
      "callback_block_uuid": "notify_stakeholders",
      "enabled": true
    }
  ],
  "schedules": [
    {
      "created_at": "2023-03-14T23:24:17.814478+00:00",
      "id": 59,
      "name": "dry haze",
      "pipeline_uuid": "aged_night",
      "schedule_interval": null,
      "schedule_type": "api",
      "start_time": "2023-03-14T23:25:00+00:00",
      "status": "inactive",
      "updated_at": "2023-03-14T23:25:27.351528+00:00"
    }
  ],
  "type": "python",
  "uuid": "example_pipeline",
  "variables": {
    "env": "prod"
  },
  "widgets": []
}

array of objects

Array of block objects. See the blocks section for more details.

string

Description for the pipeline.

array of objects

Array of extension block objects. Same shape as blocks.

string

required

Human friendly name of the pipeline.

array of objects

Mage Pro only. Pipeline-level callback configuration for callback blocks that should run once after the pipeline run reaches a terminal status. Callback decorators inside the callback block determine the behavior for success, failure, and cancellation.

Show properties

string

required

UUID of a callback block in the pipeline.

boolean

If false, the pipeline-level callback is saved but not dispatched.

array of objects

required

Array of trigger objects.

Show properties

string

required

Date and time the trigger was created.

integer

required

Trigger ID.

string

required

Name of trigger.

string

required

Pipeline UUID the trigger belongs to.

string

@once, @hourly, @daily, @weekly, @monthly

string

required

Trigger type. Supported new trigger creation uses api or time; event may appear for deprecated legacy event triggers.

datetime

Date and time when the trigger should start running.

string

required

active, inactive

datetime

required

Date and time the trigger was last updated.

string

required

The type of the pipeline: integration, pyspark, python, streaming Note that python is a standard (batch) pipeline with a python backend, while pyspark is a batch pipeline with a spark backend.

string

required

Unique identifier for the pipeline.

object

Object containing variables for the pipeline.

Hide properties

string

The property name is user defined.

array of objects

Array of widget block objects. Same shape as blocks.

{
  "blocks": [
    {
      "all_upstream_blocks_executed": true,
      "color": null,
      "configuration": {},
      "downstream_blocks": [],
      "executor_config": null,
      "executor_type": "local_python",
      "has_callback": null,
      "name": "load_titanic",
      "language": "python",
      "status": "executed",
      "type": "data_loader",
      "upstream_blocks": [],
      "uuid": "load_titanic",
      "content": "...",
      "metadata": {}
    }
  ],
  "description": null,
  "extensions": {},
  "name": "example_pipeline",
  "pipeline_callbacks": [
    {
      "callback_block_uuid": "notify_stakeholders",
      "enabled": true
    }
  ],
  "schedules": [
    {
      "created_at": "2023-03-14T23:24:17.814478+00:00",
      "id": 59,
      "name": "dry haze",
      "pipeline_uuid": "aged_night",
      "schedule_interval": null,
      "schedule_type": "api",
      "start_time": "2023-03-14T23:25:00+00:00",
      "status": "inactive",
      "updated_at": "2023-03-14T23:25:27.351528+00:00"
    }
  ],
  "type": "python",
  "uuid": "example_pipeline",
  "variables": {
    "env": "prod"
  },
  "widgets": []
}

Environment-specific configuration

API

Pipeline object

​Pipeline object

Pipeline object