Listing all mitigations of an organisation¶

Note

The threshold and traffic metrics — 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.

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

Description¶

The List-Organisation-Mitigations request returns a list of all mitigations for a specified organisation.

Requirements¶

Values of the request: Organisation ID {organisation}

Objects: none

Request¶

To request a list of all mitigations, add the Organisation ID {organisation} to the path of the request.

As a result, the user gets one or more objects 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, specified as an object.	`object`
`network`	The mitigated network or, in the case of a partial mitigation, the specific IP address.	`string`
`mitigation_type`	The type of the applied mitigation.	`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.	`number`
`configured_pps_percentage`	The configured packets per second as a percentage.	`number`
`peak_bw`	The peak bandwidth of the mitigation.	`number($float)`
`peak_pps`	The peak packets per second of the mitigation.	`number($float)`
`total_bw`	The total bandwidth of the mitigation.	`number($float)`
`total_pps`	The total packets per second of the mitigation.	`number($float)`
`dropped_bits` (if dropped data report enabled)	The total bits dropped during the mitigation.	`integer`
`dropped_packets` (if dropped data report enabled)	The total packets dropped during the mitigation.	`integer`
`has_report`	Shows whether a report is available for the mitigation.	`true` `false`
`start_user`	The users who started the mitigation, specified as an object with ID and display name.	`object`
`end_user`	The users who ended the mitigation, specified as an object with ID and display name. The value is null while the mitigation is still running.	`object`

Example¶

Example response:

{
  "data": [
    {
      "id": "xY9pQ5wR1",
      "organisation": {
        "id": "aB3cD4eF5",
        "name": "ACME GmbH"
      },
      "network": "192.0.2.0/24",
      "mitigation_type": "ACTION_MITIGATE_ONPREM",
      "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": {
        "id": "pQ7rS8tU9",
        "name": "Max Mustermann"
      },
      "end_user": {
        "id": "pQ7rS8tU9",
        "name": "Max Mustermann"
      }
    }
  ],
  "links": {
    "first": "https://datahub-api.com/api/networks?page=1",
    "last": "https://datahub-api.com/api/networks?page=5",
    "prev": null,
    "next": "https://datahub-api.com/api/networks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "https://datahub-api.com/api/networks?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://datahub-api.com/api/networks",
    "per_page": 15,
    "to": 15,
    "total": 64
  }
}

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.