Getting a network by ID¶

Note

The attributes pps_limit_percentage and bw_limit_percentage are only present if the organisation has enabled percentage thresholds.

Note

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

Sends a GET request to the endpoint /networks/{network}.

Description¶

The Get-Network request returns a single network for a specified ID.

Requirements¶

Values of the request: Network ID {network}

Objects: none

Request¶

To request a single network, add the Network ID {network} to the path of the request.

As a result, the user gets an object 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.	`object`
`name`	The name of the network.	`string`
`cidr`	The CIDR range of the network.	`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 mitigation type of the network.	`ACTION_BLACKHOLE` `ACTION_MITIGATE_ONPREM` `ACTION_MITIGATE_CLOUD`
`auto_mitigation_strategy`	The automatic mitigation strategy of the network.	`string`
`duration`	The duration of the automatic mitigation.	`integer`
`subnet_mitigation_override` (if subnet override enabled)	The mitigation override for the subnet.	`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 value.	`integer`
`bw_limit_percentage` (if percentage thresholds enabled)	The bandwidth limit as a percentage value.	`integer`
`autoStatus`	Defines whether an automatic mitigation is currently running for the network.	`true` `false`
`manualStatus`	Defines whether a manual mitigation is currently running for the network.	`true` `false`
`active_partial_manual_mitigations`	The active partial manual mitigations.	`array`
`active_partial_auto_mitigations`	The active partial automatic mitigations.	`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:

{
  "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": {}
}

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.