Umbrella Networks API: networks

Networks

The Umbrella Networks API enables you to:

  • Create a network
  • List the networks
  • Get a network
  • Update a network
  • Delete a network
  • List policies for a network

Create a Network

Before registering a network, contact Cisco Umbrella Support to get your IP range verified.

Note: For SPs, MSPs, and MSSPs, parent organizations do not have networks. To create and manage networks on behalf of child organizations, use the organizations/{childOrganizationId}/networks endpoints.

POST /organizations/{organizationId}/networks

Request Body Fields

Name Type Description
name string Network name.
Required
prefixLength integer Length of the prefix. Length must be greater than 28.
Required
status string Status of the network.
Required
isDynamic boolean Set if network uses dynamic IP address.
Required
ipAddress string Network IP address.

Request

curl -i -X POST "https://management.api.umbrella.com/v1/organizations/{organizationId}/networks" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{
    "name": "network name",
    "prefixLength": 29,
    "isDynamic": true,
    "status": "OPEN"
}'

Response

Sample response (200, OK):

{
  "originId": 0,
  "name": "network name",
  "ipAddress": "network ip address",
  "prefixLength": 32,
  "isDynamic": true,
  "isVerified": true,
  "status": "OPEN",
  "createdAt": "2022-03-09T22:18:26.625Z"
}