Listing all networks of the organisation¶

Note

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

Sends a GET request to the endpoint /networks.

Description¶

The List-Networks request returns a list of all networks of the organisation.

Requirements¶

Values of the request: none

Objects: none

Request¶

To request a list of all networks, no additional information is required in the path of the request.

As a result, the user gets one or more objects NetworkVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`id`	The ID of the network.	`string`
`organisation`	The associated organisation, referenced by `id` and `name`.	`object`
`name`	The name of the network.	`string`
`cidr`	The IP range of the network in CIDR notation.	`string`
`enabled`	Defines whether automatic mitigation is enabled.	`true` `false`
`data_only` (if available)	Defines whether the network is monitored only: visible in the dashboard, but cannot be mitigated.	`true` `false`
`mitigation_type`	The type of mitigation applied when the thresholds are exceeded.	`ACTION_BLACKHOLE` `ACTION_MITIGATE_ONPREM` `ACTION_MITIGATE_CLOUD`
`auto_mitigation_strategy`	The strategy for the automatic mitigation.	`string`
`duration`	The duration of the automatic mitigation in seconds.	`integer`
`subnet_mitigation_override` (if subnet override enabled)	Defines whether the subnet size restriction is overridden.	`true` `false`
`pps_limit`	The configured PPS limit.	`integer`
`bw_limit`	The configured bandwidth limit.	`integer`
`pps_limit_percentage` (if percentage thresholds enabled)	The PPS limit as a percentage.	`integer`
`bw_limit_percentage` (if percentage thresholds enabled)	The bandwidth limit as a percentage.	`integer`
`autoStatus`	Shows whether the network is currently in automatic mitigation.	`true` `false`
`manualStatus`	Shows whether the network is currently in manual mitigation.	`true` `false`
`active_partial_manual_mitigations`	The active partial manual mitigations of the network.	`array`
`active_partial_auto_mitigations`	The active partial automatic mitigations of the network.	`array`
`allow_manual_mitigation`	Shows whether manual mitigations can be started for the network.	`true` `false`
`extra`	Additional custom fields of the organisation.	`object`

Example¶

Example response:

{
  "data": [
    {
      "id": "xY9pQ5wR1",
      "organisation": {
        "id": "aB3cD4eF5",
        "name": "ACME GmbH"
      },
      "name": "Customer-A-Prod",
      "cidr": "192.0.2.0/24",
      "enabled": true,
      "data_only": false,
      "mitigation_type": "ACTION_BLACKHOLE",
      "auto_mitigation_strategy": "IP",
      "duration": 0,
      "subnet_mitigation_override": false,
      "pps_limit": 0,
      "bw_limit": 0,
      "pps_limit_percentage": 0,
      "bw_limit_percentage": 0,
      "autoStatus": true,
      "manualStatus": true,
      "active_partial_manual_mitigations": [
        {}
      ],
      "active_partial_auto_mitigations": [
        {}
      ],
      "allow_manual_mitigation": true,
      "extra": {}
    }
  ],
  "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.