Execute a script with provided parameters.
Rate Limited: Subject to execution limits (configurable per minute/hour) Authentication: JWT token required Access: Script must be published and user must have execution permissions
Request Schema:
{
"param1": "value1",
"param2": 123,
"param3": true,
"nested_param": {
"sub_param": "nested_value"
}
}
Path Parameters:
- script: Script identifier/name to execute
Request Body: JSON object containing script parameters
- Parameters vary by script - see individual script documentation
- Can include nested objects and arrays
- Boolean, string, and numeric values supported
Success Response Schema:
{
"data": {
"id": "exec_123456",
"script_id": "my-script",
"status": "PENDING",
"params": {
"param1": "value1",
"param2": 123
},
"user_id": "user_789",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z",
"start_time": null,
"end_time": null,
"results": null
}
}
Execution States:
- PENDING: Execution queued, waiting to start
- RUNNING: Currently executing
- SUCCESS: Completed successfully
- FAILED: Execution failed with error
- CANCELLED: Execution was cancelled
Error Responses:
- 400 Bad Request: Invalid parameters or script not in valid state
- 401 Unauthorized: JWT token required
- 404 Not Found: Script does not exist
- 429 Too Many Requests: Execution rate limit exceeded
- 500 Internal Server Error: Execution creation failed
post/api/v1/script/{script}/run
Path parameters
scriptstring required
Path parameter: script
Request body
object required
Response
Success
object required
Changes
No recorded changes to this endpoint across all 1 revision of this API.