API docs by Redocly

Open Security Responder API (1.0.0)

Download OpenAPI specification:

SOAR (Security Orchestration, Automation and Response) microservice

Health Check

Health check endpoint

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "redis_connected": true,
  • "playbooks_loaded": 0
}

List Playbooks

List all available playbooks

Responses

Response samples

Content type
application/json
{
  • "playbooks": [
    ],
  • "total": 0
}

Execute Playbook

Execute a playbook

path Parameters
playbook_id
required
string (Playbook Id)
Request Body schema: application/json
trigger_data
object (Trigger Data)
Default: {}

Data provided by the trigger

Context (object) or Context (null) (Context)
Default: {}

Additional context for the execution

Responses

Request samples

Content type
application/json
{
  • "trigger_data": { },
  • "context": { }
}

Response samples

Content type
application/json
null

Get Execution Status

Get execution status and results

path Parameters
run_id
required
string (Run Id)

Responses

Response samples

Content type
application/json
{
  • "run_id": "string",
  • "playbook_id": "string",
  • "playbook_name": "string",
  • "status": "pending",
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "trigger_data": { },
  • "step_results": [
    ],
  • "context": { },
  • "logs": [
    ],
  • "error": "string",
  • "duration_seconds": 0
}

Cancel Execution

Cancel a running execution

path Parameters
run_id
required
string (Run Id)

Responses

Response samples

Content type
application/json
null

Reload Playbooks

Reload playbooks from disk

Responses

Response samples

Content type
application/json
null

List Connectors

List all available connectors and their actions

Responses

Response samples

Content type
application/json
null

Root

Root endpoint with API information

Responses

Response samples

Content type
application/json
null