{ "opencollection": "1.0.0", "info": { "name": "Backstage Auth Actions Tasks API", "version": "1.0.0" }, "items": [ { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Backstage List scaffolder tasks", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7007/api/auth/v2/tasks", "params": [ { "name": "createdBy", "value": "", "type": "query", "description": "Filter tasks by the user who created them." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Lists scaffolder tasks, optionally filtered by the user who created them. Returns task metadata and status information." }, { "info": { "name": "Backstage Create a scaffolder task", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7007/api/auth/v2/tasks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new scaffolder task to execute a software template. The task runs asynchronously and its progress can be monitored through the event stream or logs endpoints." }, { "info": { "name": "Backstage Get task by ID", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7007/api/auth/v2/tasks/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path", "description": "The unique identifier of the task." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves the details and current status of a scaffolder task." }, { "info": { "name": "Backstage Cancel a task", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7007/api/auth/v2/tasks/:taskId/cancel", "params": [ { "name": "taskId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Requests cancellation of a running scaffolder task." }, { "info": { "name": "Backstage Get task event stream", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7007/api/auth/v2/tasks/:taskId/eventstream", "params": [ { "name": "taskId", "value": "", "type": "path" }, { "name": "after", "value": "", "type": "query", "description": "Only return events after this sequence number." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a server-sent event stream of task progress events. This endpoint streams real-time updates about the task execution including step progress, log messages, and completion status." }, { "info": { "name": "Backstage Get task logs", "type": "http" }, "http": { "method": "GET", "url": "https://localhost:7007/api/auth/v2/tasks/:taskId/logs", "params": [ { "name": "taskId", "value": "", "type": "path" }, { "name": "after", "value": "", "type": "query", "description": "Only return log entries after this sequence number." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves the log entries for a scaffolder task, providing detailed information about each step of template execution." }, { "info": { "name": "Backstage Dry-run a template", "type": "http" }, "http": { "method": "POST", "url": "https://localhost:7007/api/auth/v2/dry-run", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Executes a template as a dry run without actually performing any side effects. Useful for testing and validating templates before actual execution." } ] } ], "bundled": true }