Viewing a list of active lists on the correlator
GET /api/v1/activeLists
The target correlator must be running.
Access: General administrator, Tenant administrator, Tier 2 analyst, Tier 1 analyst.
Query parameters
Name | Data type | Mandatory | Description | Value example |
correlatorID | string | Yes | Correlator service ID | 00000000-0000-0000-0000-000000000000 |
Response
HTTP code: 200
Format: JSON
|
Possible errors
HTTP code | Description | message field value | details field value |
400 | Correlator service ID is not specified | query parameter required | correlatorID |
403 | The user does not have the required role in the correlator tenant | access denied |
|
404 | The service with the specified identifier (correlatorID) was not found | service not found |
|
406 | The service with the specified ID (correlatorID) is not a correlator | service is not correlator |
|
406 | The correlator did not execute the first start | service not paired |
|
406 | The correlator tenant is disabled | tenant disabled |
|
50x | Failed to access the correlator API | correlator API request failed | variable |
500 | Failed to decode the response body received from the correlator | correlator response decode failed | variable |
500 | Any other internal errors | variable | variable |