Stopping a manual mitigation by ID¶
Sends a POST request to the endpoint /mitigations/{mitigation}/stop.
Description¶
The Stop-Mitigation request stops a specific manual mitigation by its ID.
Requirements¶
Values of the request: Mitigation ID {mitigation}
Objects: none
Request¶
To stop a manual mitigation, add the Mitigation ID {mitigation} to the path of the request. No further information is required.
As a result, the user gets an object MitigationVO with the information about the stopped mitigation.
The object provides the following information:
| Attributes | Description | Values |
|---|---|---|
id |
The ID of the mitigation. | string |
organisation |
The associated organisation. | object |
network |
The network, or the specific IP that is mitigated in the case of a partial mitigation. | string |
mitigation_type |
The type of the mitigation. |
|
mitigation_cause |
How the mitigation was triggered. |
|
start |
The start date in ISO 8601 format. | string($date-time) |
end |
The end date 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. | number($float) |
actual_pps |
The actual packets per second. | number($float) |
configured_bw |
The configured bandwidth. | number($float) |
configured_pps |
The configured packets per second. | number($float) |
configured_bw_percentage |
The configured bandwidth as a percentage. | number |
configured_pps_percentage |
The configured packets per second as a percentage. | number |
peak_bw |
The peak bandwidth. | number($float) |
peak_pps |
The maximum packets per second. | number($float) |
total_bw |
The total bandwidth. | number($float) |
total_pps |
The total packets per second. | number($float) |
has_report |
Shows whether a report is available for the mitigation. |
|
start_user |
The person who started the mitigation. | object |
end_user |
The person who ended the mitigation. This value is null while the mitigation is running. | object |
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | The request has succeeded. |
| 304 | The resource has not changed since the last request. |
| 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. |