Umbrella Networks API: internal domains

Internal Domains

The Umbrella Internal Domains API enables you to:

  • Create an internal domain
  • List the internal domains
  • Get an internal domain
  • Update an internal domain
  • Delete an internal domain

Create an Internal Domain

POST /organizations/{organizationId}/internaldomains

Request Path Parameters

Name Type Description
organizationId integer The organization ID.
Required

Request Body Fields

Name Type Description
domain string The name of the internal domain.
Required
description string A description about the internal domain. The description must contain at least one character but no more than 50 characters.
includeAllVAs boolean Specifies whether to apply the internal domain to all virtual appliances.
includeAllMobileDevices boolean Specifies whether to apply the internal domain to all mobile devices.

Request

curl -i -X POST "https://management.api.umbrella.com/v1/organizations/{organizationId}/internaldomains" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{ "domain": "internal domain name" }'

Response

Sample response (200, OK):

{
    "id": 12874,
    "domain": "The name of the internal domain",
    "description": "An description about an internal domain",
    "includeAllVAs": false,
    "includeAllMobileDevices": false,
    "createdAt": "2022-03-09T22:18:26.625Z",
    "modifiedAt": "2022-03-10T22:18:26.625Z"
}

List Internal Domains

GET /organizations/{organizationId}/internaldomains

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. The default page value is 1.
limit integer Specifies the number of records to return per page. The default limit value is 100.
name string The name of the Internal Network.

Request

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

Response

Sample response (200, OK):

[
    {
        "id": 12874,
        "domain": "The name of the internal domain",
        "description": "An description about an internal domain",
        "includeAllVAs": false,
        "includeAllMobileDevices": false,
        "createdAt": "2022-03-09T22:18:26.625Z",
        "modifiedAt": "2022-03-10T22:18:26.625Z"
    }
]