Adding a network to the organisation

Note

The body does not contain the id, created, and modified attributes. The system sets these values after the entry has been created.

Note

The pps_limit and pps_limit_percentage attributes are mutually exclusive; the same applies to bw_limit and bw_limit_percentage.

Note

For ACTION_MITIGATE_CLOUD, IPv4 networks require at least /24 and IPv6 networks at least /48.

Note

This request is available to SOC users only.

Sends a POST request to the endpoint /networks.

Description

The Add-Network request adds a new network to the organisation.

Requirements

Values of the request: none

Objects: NetworkVO

Request

To add a network, no additional information is required in the path of the request.

For a detailed specification of which information is required to add a network, an object NetworkVO with the following attributes must be defined in the body:

Attributes	Description	Values
`cidr`	The IP range in CIDR notation. Must be unique within the organisation.	`string`
`enabled`	Defines whether automatic mitigation is enabled for the network. If `false`, no automatic mitigations are triggered; manual and ops mitigations are not affected.	`true` `false`
`pps_limit`	The absolute PPS threshold. Required if `pps_limit_percentage` is not specified.	`integer`
`bw_limit`	The absolute bandwidth threshold in Mbps. Required if `bw_limit_percentage` is not specified.	`integer`

The following attributes are optional:

Attributes	Description	Values
`name`	The name of the network.	`string`
`team_id`	The ID of the organisation to which the network is added.	`string`
`pps_limit_calculated`	The calculated PPS threshold.	`integer`
`bw_limit_calculated`	The calculated bandwidth threshold.	`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_mitigations`	The active partial manual mitigations.	`array`
`active_partial_auto_mitigations`	The active partial automatic mitigations.	`array`
`country_blocks`	The active country blocks.	`array`
`allow_manual_mitigation`	Shows whether manual mitigations can be started for the network. The default value is `true` if the attribute is missing.	`true` `false`
`extra`	Additional custom fields of the organisation.	`object`
`mitigation_type`	The mitigation type to apply.	`ACTION_BLACKHOLE` `ACTION_MITIGATE_ONPREM` `ACTION_MITIGATE_CLOUD`
`network_type`	The registration type of the network.	`string`
`customer_reference`	The identifier of the customer reference.	`string`
`emails`	The email addresses that are notified when a mitigation starts or ends.	`array`
`duration`	The maximum mitigation duration in seconds (minimum 300).	`integer`
`auto_mitigation_strategy`	The strategy for the automatic mitigation.	`IP` `CIDR` `INTERNET` `DEFAULT`

In response, the system returns the object NetworkVO with the information about the new network.

The object provides the following information:

Attributes	Description	Values
`message`	The status message of the request.	`string`
`network`	The newly created network as a `NetworkVO` object.	`object`

Example

Example request body:

{
  "name": "Production Network",
  "cidr": "127.0.0.1/32",
  "enabled": true,
  "pps_limit": 1000,
  "bw_limit": 200,
  "pps_limit_calculated": 800,
  "bw_limit_calculated": 160,
  "team_id": "xY9pQ5wR1",
  "autoStatus": false,
  "manualStatus": false,
  "active_partial_mitigations": [
    {}
  ],
  "active_partial_auto_mitigations": [
    {}
  ],
  "country_blocks": [
    {}
  ],
  "allow_manual_mitigation": true,
  "extra": {},
  "mitigation_type": "string",
  "network_type": "string",
  "customer_reference": "abc",
  "emails": [
    "string"
  ],
  "duration": 3600,
  "auto_mitigation_strategy": "ip"
}

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.
422	The request was unsuccessful because the submitted data could not be processed.