Get Pipeline

Overview

Retrieve detailed information about a specific pipeline by its ID, including its jobs, configuration, and current status.

Path Parameters

Parameter	Type	Required	Description
`pipelineId`	string	Yes	The UUID of the pipeline

Examples

Get Pipeline Details

GET /platform/pipeline/1b33ad2f-33d3-4837-9eeb-83c82c8b909d

Response (200 OK):

{
  "status": true,
  "data": {
    "id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d",
    "name": "postgres_orders_pipeline",
    "description": "Pipeline to sync orders from PostgreSQL",
    "cron": "0 6 * * *",
    "customer_id": "acme_corp",
    "status": "active",
    "created_at": "2024-12-01T10:00:00Z",
    "updated_at": "2024-12-15T14:30:00Z",
    "jobs": [
      {
        "job_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d_0",
        "job_name": "orders_extraction",
        "input": {
          "connector": "jdbc",
          "plugin": "postgresql",
          "table_schema": "public",
          "table_name": "orders",
          "load_type": "incremental",
          "incremental_column_name": "updated_at",
          "incremental_column_type": "timestamp with time zone"
        },
        "output": {
          "plugin": "dadosfera_snowflake",
          "table_name": "tb__xqfu8g__public__orders"
        }
      }
    ]
  }
}

Python Example

import requests

BASE_URL = "https://maestro.dadosfera.ai"
PIPELINE_ID = "1b33ad2f-33d3-4837-9eeb-83c82c8b909d"

# Get pipeline details
response = requests.get(
    f"{BASE_URL}/platform/pipeline/{PIPELINE_ID}",
    headers=headers
)

pipeline = response.json()
print(f"Pipeline: {pipeline['data']['name']}")
print(f"Status: {pipeline['data']['status']}")
print(f"Jobs: {len(pipeline['data']['jobs'])}")

Response Structure

Field	Type	Description
`id`	string	Pipeline UUID (normalized with underscores)
`name`	string	Pipeline display name
`description`	string	Pipeline description
`cron`	string	Cron expression for scheduling (null for manual only)
`customer_id`	string	Customer identifier
`status`	string	Pipeline status: `active`, `paused`, `error`
`created_at`	string	ISO 8601 creation timestamp
`updated_at`	string	ISO 8601 last update timestamp
`jobs`	array	List of job configurations

Job Object

Field	Type	Description
`job_id`	string	Job identifier (pipeline_id + job_index)
`job_name`	string	Job display name
`input`	object	Source configuration (varies by connector type)
`output`	object	Destination configuration
`transformations`	array	List of transformation configurations

Error Responses

404 Not Found

{
  "detail": {
    "status": false,
    "exception_type": "PipelineNotFound",
    "traceback": "Pipeline with id 1b33ad2f_33d3_4837_9eeb_83c82c8b909d not found",
    "data": null
  }
}

Pipeline ID Format

The pipelineId can be provided in either format:

Hyphenated UUID: 1b33ad2f-33d3-4837-9eeb-83c82c8b909d
Underscored: 1b33ad2f_33d3_4837_9eeb_83c82c8b909d

Maestro automatically normalizes the ID before forwarding to Platform-API.

Notes

For a list of all pipelines, use GET /platform/pipelines
For detailed job configuration, use the connector-specific endpoints:
- JDBC: GET /platform/jobs/jdbc/:jobId
- Singer: GET /platform/jobs/singer/:jobId