Execute Pipeline | Dadosfera Maestro Platform API

Trigger immediate execution of a pipeline

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Trigger an immediate execution of a pipeline. This bypasses the scheduled cron and runs the pipeline right away.

Request Body

FieldTypeRequiredDescription
pipeline_idstringYesThe UUID of the pipeline to execute

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

Examples

Execute a Pipeline

POST /platform/pipeline/execute

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

Response (200 OK):

{
  "status": true,
  "data": {
    "message": "Pipeline execution triggered successfully",
    "pipeline_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d",
    "run_id": "manual__2024-12-18T10:30:00+00:00"
  }
}

Python Example

import requests
import json

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

# Execute pipeline
response = requests.post(
    f"{BASE_URL}/platform/pipeline/execute",
    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 - Pipeline Paused

{
  "detail": {
    "status": false,
    "exception_type": "PipelinePaused",
    "traceback": "Cannot execute paused pipeline. Use /pipeline/unpause first.",
    "data": null
  }
}

400 Bad Request - Missing Pipeline ID

{
  "detail": "pipeline_id is required"
}

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.

Notes

  • This endpoint triggers an immediate execution, regardless of the pipeline's cron schedule
  • If the pipeline is currently running, a new execution will be queued
  • Paused pipelines cannot be executed - use POST /platform/pipeline/unpause first
  • After execution, monitor progress using GET /platform/pipeline/:pipelineId/pipeline_run
Body Params
string
required
string
required
Responses
200

Pipeline execution triggered

403

Pipeline status not valid for execution

404

Pipeline not found or not ready

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!