Umbrella Networks API: internal networks

Internal Networks

The Umbrella Internal Networks API enables you to:

  • Create an internal network
  • List the internal networks
  • Get an internal network
  • Update an internal network
  • Delete an internal network
  • List policies for an internal network

Create an Internal Network

POST /organizations/{organizationId}/internalnetworks

Request Path Parameters

Name Type Description
organizationId integer The organization ID.
Required

Request Body Fields

When creating an internal network, you can set one of the optional identity fields in the request body: siteId, networkId, or tunnelId. Choose the identity field that matches your type of Umbrella policy.

Name Type Description
prefixLength integer Length of prefix.
Required
ipAddress string Internal network IPv4 address.
Required
name string Internal network label.
Required
siteId integer For a DNS policy, set a site ID.
networkId integer For a Web policy (through proxy chaining), set a network ID.
tunnelId integer For a Web policy (through IPsec tunnel), set a tunnel ID.

Request

curl -i -X POST "https://management.api.umbrella.com/v1/organizations/{organizationId}/internalnetworks" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{
    "prefixLength": 27,
    "ipAddress": "internal network ipv4 address",
    "name": "internal network label"
}'

Response

Sample response (200, OK):

{
    "originId": 12673,
    "name": "The name of an internal network",
    "ipAddress": "The IPv4 address",
    "prefixLength": 27,
    "siteName": "The name of the site",
    "siteId": 127237,
    "createdAt": "2022-03-09T22:18:26.625Z",
    "modifiedAt": "2022-03-10T22:18:26.625Z"
}

List Internal Networks

GET /organizations/{organizationId}/internalnetworks

Request Path Parameters

Name Type Description
organizationId integer The organization ID.
Required

Request Query Parameters

Name Type Description
page integer Specifies a page number in the collection.
limit integer Specifies the number of records to return per page.
name string The name of the Internal Network.

Request

curl -i -X GET "https://management.api.umbrella.com/v1/organizations/{organizationId}/internalnetworks" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json'

Response

Sample response (200, OK):

[
    {
        "originId": 12673,
        "name": "The name of the internal network",
        "ipAddress": "The IPv4 address",
        "prefixLength": 27
    }
]

Get an Internal Network

GET /organizations/{organizationId}/internalnetworks/{internalNetworkId}

Request Path Parameters

Name Type Description
organizationId integer The organization ID.
Required
internalNetworkId integer The origin ID (originId) of the Internal Network.
Required

Request

curl -i -X GET "https://management.api.umbrella.com/v1/organizations/{organizationId}/internalnetworks/{internalNetworkId}" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json'

Response

Sample response (200, OK):

{
    "originId": 12673,
    "name": "The name of the internal network",
    "ipAddress": "The IPv4 address",
    "prefixLength": 27
}