Exporting records from a context table
GET /api/v1/contextTables/export
The target correlator must be running.
Access: General administrator, Tenant administrator, Tier 2 analyst, Tier 1 analyst.
Query parameters (URL Query)
Name | Data type | Mandatory | Description | Value example |
correlatorID | string | Yes | Correlator service ID | 00000000-0000-0000-0000-000000000000 |
contextTableID | string | If contextTableName is not specified | Context table ID | 00000000-0000-0000-0000-000000000000 |
contextTableName | string | If contextTableID is not specified | Name of the context table | Attackers |
Response
HTTP code: 200
Format: application/octet-stream
Body: exported context table data, in the 'internal' format: each row contains one individual JSON object.
Possible errors
HTTP code | Description | message field value | details field value |
|---|---|---|---|
400 | Correlator service ID is not specified. | query parameter required | correlatorID |
400 | Neither the contextTableID parameter nor the contextTableName parameter is specified | one of query parameters required | contextTableID, contextTableName |
403 | The user does not have the required role in the correlator tenant. | access denied | - |
404 | The service with the specified ID (correlatorID) was not found. | service not found | - |
404 | The context table was not found. | context table 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 tenant of the correlator is disabled. | tenant disabled | - |
406 | More than one context table found by a search for contextTableName. | more than one matching context tables found | - |
50x | Failed to gain access to the correlator API. | correlator API request failed | variable |
500 | Any other internal error. | variable | variable |
