PyExecutor REST API

List all workflows in your organization.

curl -H "X-API-Key: key" \
  https://pyexecutor.example.com/api/workflows/

Response:

{
  "count": 5,
  "results": [
    {
      "id": 12,
      "name": "Service Health Monitor",
      "description": "Monitor service health",
      "is_active": true,
      "schedule": "0 */6 * * *",
      "created_at": "2026-02-28T10:30:00Z"
    }
  ]
}

Get a specific workflow with all steps.

curl -H "X-API-Key: key" \
  https://pyexecutor.example.com/api/workflows/12/

Execute a workflow immediately. Returns a job object.

curl -X POST -H "X-API-Key: key" \
  -H "Content-Type: application/json" \
  -d '{"context": {"custom_var": "value"}}' \
  https://pyexecutor.example.com/api/workflows/12/execute/

Response:

{
  "id": 839,
  "workflow": 12,
  "status": "RUNNING",
  "triggered_by": "API",
  "created_at": "2026-02-28T15:45:00Z"
}

Create a new workflow.

curl -X POST -H "X-API-Key: key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Workflow",
    "description": "My workflow",
    "is_active": true,
    "steps": []
  }' \
  https://pyexecutor.example.com/api/workflows/

List all workflow executions (jobs).

curl -H "X-API-Key: key" \
  'https://pyexecutor.example.com/api/jobs/?workflow=12&status=SUCCESS'

Get job details, logs, and context.

curl -H "X-API-Key: key" \
  https://pyexecutor.example.com/api/jobs/839/

Response:

{
  "id": 839,
  "workflow": 12,
  "workflow_name": "Service Health Monitor",
  "status": "SUCCESS",
  "triggered_by": "API",
  "execution_context": {
    "health_data": {...},
    "all_clear_msg": "All services healthy"
  },
  "workflow_output": {
    "status": "ok"
  },
  "logs": "[INFO] Job started...",
  "created_at": "2026-02-28T15:45:00Z",
  "completed_at": "2026-02-28T15:46:30Z"
}

Cancel a running job.

curl -X POST -H "X-API-Key: key" \
  https://pyexecutor.example.com/api/jobs/839/cancel/

Create or update an encrypted secret.

curl -X POST -H "X-API-Key: key" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "DB_PASSWORD",
    "value": "super_secret_password"
  }' \
  https://pyexecutor.example.com/api/secrets/

List all secrets (values are hidden).

List approval requests for your organization. Filter by status.

curl -H "Authorization: Bearer $TOKEN" \
  "https://your-instance/api/approvals/?status=pending"

# Response
{
  "count": 3,
  "results": [
    {
      "id": 30,
      "approval_config": {
        "id": 1,
        "approver_emails": ["ops@company.com", "lead@company.com"],
        "approval_title": "Approval required for Deploy Pipeline",
        "required_approvers": 1,
        "require_comment": false,
        "timeout_days": 1
      },
      "workflow_name": "Deploy Pipeline",
      "job": 2403,
      "status": "pending",
      "approval_token": "eBGYR_er...",
      "created_at": "2026-03-07T10:00:00Z",
      "expires_at": "2026-03-08T10:00:00Z",
      "approvals_count": 0
    }
  ]
}

Retrieve an approval request by its unique token. No authentication required — used in email links.

Approve a pending request. Optionally include a comment and approver email.

curl -X POST \
  "https://your-instance/api/approvals/token/eBGYR_er.../approve/" \
  -H "Content-Type: application/json" \
  -d '{"comment": "Looks good, approved.", "approver_email": "ops@company.com"}'

Reject a pending request with an optional reason.

curl -X POST \
  "https://your-instance/api/approvals/token/eBGYR_er.../reject/" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Not ready for production yet."}'

Resend the approval notification email to all designated approvers.

List all scripts in the current organization. Supports multi-language: Python, JavaScript, PowerShell, Bash, Go.

curl -H "Authorization: Bearer $TOKEN" \
  https://your-instance/api/scripts/

# Response
[{
  "id": 42,
  "name": "health_check",
  "language": "python",
  "folder": "monitoring",
  "variables": {"inputs": [...], "outputs": [...]},
  "created_at": "2026-03-01T10:00:00Z"
}]

Security-scan a script for dangerous patterns (17 checks including file system access, network calls, subprocess, eval). Returns warnings before saving.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  -d '{"content": "import os; os.system(\"rm -rf /\")", "language": "python"}' \
  https://your-instance/api/scripts/validate-content/

# Response
{"warnings": ["Dangerous pattern detected: os.system()"]}

List installed packages, optionally filtered by language.

Install a package. Supports pip (Python), npm (JavaScript), and PowerShell Gallery.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  -d '{"name": "lodash", "language": "javascript"}' \
  https://your-instance/api/packages/install/

Search package registries (PyPI, npm, PowerShell Gallery) for available packages.

List all connectors. Types: database (PostgreSQL, MySQL), http, ai (Gemini, OpenAI, Azure OpenAI, LM Studio, Ollama), notification (Email, Slack, Teams, Discord, Telegram, PagerDuty, WhatsApp).

Test a connector's connectivity before using it in workflows.

List all workflow templates. Filter by category, difficulty, featured, or search.

Get featured templates curated by the platform.

Top 10 templates by clone count.

Clone a template into a new workflow with custom config values.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  -d '{"config": {"api_key": "sk-xxx", "target_url": "https://api.example.com"}}' \
  https://your-instance/api/templates/ghostwriter/clone-and-configure/

# Response
{"workflow_id": 15, "name": "Ghostwriter (clone)", "status": "created"}

List all version-controlled repositories (linked to workflows or scripts).

List or create branches. Types: main, staging, develop, feature, hotfix, release. Supports branch protection.

List or create commits. Each commit stores a SHA256-hashed content snapshot with additions/deletions count.

View unified diffs with structured JSON changes between two commits.

Manage pull requests with approval workflow. Status: open, approved, rejected, merged, closed.

List or create named tags pointing to specific commits for release versioning.

List or create organizations. Each org is a multi-tenant boundary with its own roles, members, resources, and SMTP settings.

List organization members with their roles. Add/remove members, change roles.

Manage roles with hierarchical inheritance. System roles: Admin, Editor, Executor, Viewer, Report Analyst. Custom roles supported.

List all available permission codes across 12 categories (workflow, script, connector, job, secret, etc.).

Manage API keys with scoped access: read, execute, edit, analytics, full. Supports expiry, rotation, and resource constraints.

Query immutable audit logs. Filter by action, user, resource, status, and date range. Supports compliance export.

Aggregate dashboard: total jobs, success rate, CPU/memory/disk usage, AI token counts.

Daily job execution counts for trend analysis.

Jobs by trigger type: manual, webhook, scheduled, API.

Most-used workflows and scripts by execution count.

Connector status, latency, and error rates.

Job execution duration trends over time.

API traffic patterns across published endpoints.

Security events: auth failures, denied access, suspicious patterns.

MCP tool invocation counts and performance metrics.

Execute a workflow synchronously — the request blocks until the job completes and returns the result directly. Ideal for API integrations that need immediate results.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  -d '{"workflow_id": 5, "context": {"input": "data"}}' \
  https://your-instance/api/jobs/run-sync/

# Response includes the full job result
# Header: X-Sync-Execution: true

Trigger a webhook in synchronous mode. Add ?sync=true to block until execution completes and return the workflow output.

Get or update system settings.

Toggle maintenance mode. When enabled, running jobs are auto-cancelled and new executions are blocked.

Export system data as a JSON backup file.

Restore the system from a JSON backup.

Check scheduler health status and next run times.

Global search across workflows, scripts, connectors, and other resources.

Interactive Swagger UI for exploring the full API. OpenAPI schema available at /api/schema/.

AI-powered code generation — describe what you need and get script code back.