Getting a mitigation by ID¶

Note

The threshold and traffic values — configured_bw, configured_pps, configured_bw_percentage, configured_pps_percentage, actual_bw, actual_pps, peak_bw, peak_pps, total_bw, total_pps and (if the dropped data report feature is enabled) dropped_bits and dropped_packets — are only returned for automatic mitigations (triggered by detection). For manual mitigations that contain no detection data, they are omitted. The user must have at least READ permissions for the selected time period.

Note

SOC accounts must instead address an organisation explicitly via the endpoint /organisations/{organisation}/mitigations.

Sends a GET request to the endpoint /mitigations/{mitigation}.

Description¶

The Get-Mitigation request returns a single mitigation for a specified ID.

Requirements¶

Values of the request: Mitigation ID {mitigation}

Objects: none

Request¶

To request a mitigation, add the Mitigation ID {mitigation} to the path of the request.

As a result, the user gets an object MitigationVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`id`	The ID of the mitigation.	`string`
`organisation`	The associated organisation of the mitigation.	`object`
`network`	The network, or the specific IP address that is mitigated in the case of a partial mitigation.	`string`
`mitigation_type`	The applied mitigation type.	`ACTION_BLACKHOLE` `ACTION_MITIGATE_ONPREM` `ACTION_MITIGATE_CLOUD`
`mitigation_cause`	How the mitigation was triggered.	`MANUAL_TRIGGER` `AUTO_TRIGGER` `OPS_TRIGGER` `UNKNOWN_TRIGGER`
`start`	The start date of the mitigation in ISO 8601 format.	`string($date-time)`
`end`	The end date of the mitigation in ISO 8601 format.	`string($date-time)`
`created_at`	The creation date in ISO 8601 format.	`string($date-time)`
`updated_at`	The last modification date in ISO 8601 format.	`string($date-time)`
`actual_bw`	The actual bandwidth of the mitigation.	`number($float)`
`actual_pps`	The actual packets per second of the mitigation.	`number($float)`
`configured_bw`	The configured bandwidth of the mitigation.	`number($float)`
`configured_pps`	The configured packets per second of the mitigation.	`number($float)`
`configured_bw_percentage`	The configured bandwidth as a percentage value.	`number`
`configured_pps_percentage`	The configured packets per second as a percentage value.	`number`
`peak_bw`	The peak bandwidth of the mitigation.	`number($float)`
`peak_pps`	The peak value of the packets per second of the mitigation.	`number($float)`
`total_bw`	The total bandwidth of the mitigation.	`number($float)`
`total_pps`	The total number of packets per second of the mitigation.	`number($float)`
`dropped_bits` (if dropped data report enabled)	The total number of bits dropped during the mitigation.	`integer`
`dropped_packets` (if dropped data report enabled)	The total number of packets dropped during the mitigation.	`integer`
`has_report`	Shows whether a report is available for the mitigation.	`true` `false`
`start_user`	The user who started the mitigation.	`object`
`end_user`	The user who ended the mitigation; null while the mitigation is running.	`object`
`peaks`	The breakdown of the peak traffic of the mitigation.	`object`

Example¶

Example response:

{
  "id": "string",
  "organisation": {},
  "network": "string",
  "mitigation_type": "ACTION_BLACKHOLE",
  "mitigation_cause": "MANUAL_TRIGGER",
  "start": "2026-01-01T00:00:00+00:00",
  "end": "2026-01-01T00:00:00+00:00",
  "created_at": "2026-01-01T00:00:00+00:00",
  "updated_at": "2026-01-01T00:00:00+00:00",
  "actual_bw": 0,
  "actual_pps": 0,
  "configured_bw": 0,
  "configured_pps": 0,
  "configured_bw_percentage": 0,
  "configured_pps_percentage": 0,
  "peak_bw": 0,
  "peak_pps": 0,
  "total_bw": 0,
  "total_pps": 0,
  "dropped_bits": 0,
  "dropped_packets": 0,
  "has_report": true,
  "start_user": {},
  "end_user": {},
  "peaks": {}
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.