Pause Pipeline

Overview

Pause a pipeline to stop its scheduled executions. Paused pipelines will not run automatically based on their cron schedule, and manual execution attempts will be blocked.

Request Body

Note: The customer_id is automatically injected by Maestro from the authenticated user's JWT token.

Examples

Pause a Pipeline

POST /platform/pipeline/pause

{
  "pipeline_id": "1b33ad2f-33d3-4837-9eeb-83c82c8b909d"
}

Response (200 OK):

{
  "status": true,
  "data": {
    "message": "Pipeline paused successfully",
    "pipeline_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d"
  }
}

Python Example

import requests

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

# Pause pipeline
response = requests.post(
    f"{BASE_URL}/platform/pipeline/pause",
    headers=headers,
    json={"pipeline_id": PIPELINE_ID}
)

print(response.json())

Error Responses

404 Not Found - Pipeline Not Found

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

400 Bad Request - Already Paused

{
  "detail": {
    "status": false,
    "exception_type": "PipelineAlreadyPaused",
    "traceback": "Pipeline is already paused",
    "data": null
  }
}

Pipeline ID Format

The pipeline_id 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.

Behavior

When a pipeline is paused:

• Scheduled cron executions are suspended
• Manual executions via POST /platform/pipeline/execute are blocked
• Currently running executions continue until completion
• The pipeline status changes to paused

Notes

• Use POST /platform/pipeline/unpause to resume scheduled executions
• Pausing does not affect historical run data or pipeline configuration
• This is useful for maintenance windows or when investigating issues