The Management API Developer Hub

Welcome to the Management API developer hub. You'll find comprehensive guides and documentation to help you start working with the Management API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Service Providers

 

/serviceproviders/{serviceProviderId}

Return a Service Provider

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/serviceproviders/serviceProviderId
curl --request GET \
  --url https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serviceProviderId
integer
required

The ServiceProviderID related to this Service Provider

Response

Return a Service Provider

packageNamestring

name of service provider's subscribed package

seatsTotalinteger

number of seats allocated to service provider

seatsUsedinteger

number of seats used by service provider

customerCountinteger

number of seats used by service provider

statusstring

status of service provider

rebillAtstring

iso8601 timestamp of when service provider was rebilled

expiresAtstring

iso8601 timestamp of when service provider's subscription ends

/serviceproviders/{serviceProviderId}/customers

Create a new Customer

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers
curl --request POST \
  --url https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers
var request = require("request");

var options = { method: 'POST',
  url: 'https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serviceProviderId
integer
required

The ServiceProviderID related to this Customer

Body Params

customerName
string
required

customer organization name

seats
integer
required

number of users

streetAddress
string
required

street address

streetAddress2
string

street address2

city
string
required

city

state
string
required

state

countryCode
string
required

country code

zipCode
string

zip code

packageId
integer
required

package id

dealId
string

deal id

adminEmails
array of strings
required

array of admin emails

ccwDealOwnerEmails
array of strings

array of CCW deal owner emails

Response

Create a new Customer

customerIdinteger

customerID

customerNamestring

customer organization name

packageNamestring

name of customer's subscribed package

seatsinteger

number of users

streetAddressstring

street address

streetAddress2string

street address2

citystring

city

statestring

state

countryCodestring

country code

zipCodestring

zip code

packageIdinteger

package id

dealIdstring

deal id

adminEmailsarray

array of admin emails

ccwDealOwnerEmailsarray

array of CCW deal owner emails

createdAtstring

iso8601 timestamp of when customer was created

modifiedAtstring

iso8601 timestamp of when customer was last modified

/serviceproviders/{serviceProviderId}/customers

Return a list of Customer

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers
curl --request GET \
  --url https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serviceProviderId
integer
required

The ServiceProviderID related to this Customer

Query Params

limit
integer
page
integer

Response

Return a list of Customers

/serviceproviders/{serviceProviderId}/customers/{customerId}

Return a Customer

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId
curl --request GET \
  --url https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serviceProviderId
integer
required

The ServiceProviderID related to this Customer

customerId
integer
required

The customerID related to this Customer

Response

Return a Customer

customerIdinteger

customerID

customerNamestring

customer organization name

packageNamestring

name of customer's subscribed package

seatsinteger

number of users

streetAddressstring

street address

streetAddress2string

street address2

citystring

city

statestring

state

countryCodestring

country code

zipCodestring

zip code

packageIdinteger

package id

dealIdstring

deal id

adminEmailsarray

array of admin emails

ccwDealOwnerEmailsarray

array of CCW deal owner emails

createdAtstring

iso8601 timestamp of when customer was created

modifiedAtstring

iso8601 timestamp of when customer was last modified

/serviceproviders/{serviceProviderId}/customers/{customerId}

Delete a Customer

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serviceProviderId
integer
required

The ServiceProviderID related to this Customer

customerId
integer
required

The customerID related to this Customer

Response

Delete a Customer

customerIdinteger

customerID

customerNamestring

customer organization name

packageNamestring

name of customer's subscribed package

seatsinteger

number of users

streetAddressstring

street address

streetAddress2string

street address2

citystring

city

statestring

state

countryCodestring

country code

zipCodestring

zip code

packageIdinteger

package id

dealIdstring

deal id

adminEmailsarray

array of admin emails

ccwDealOwnerEmailsarray

array of CCW deal owner emails

createdAtstring

iso8601 timestamp of when customer was created

modifiedAtstring

iso8601 timestamp of when customer was last modified

/serviceproviders/{serviceProviderId}/customers/{customerId}

Update a Customer

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId
curl --request PUT \
  --url https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/serviceproviders/serviceProviderId/customers/customerId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

serviceProviderId
integer
required

The ServiceProviderID related to this Customer

customerId
integer
required

The customerID related to this Customer

Body Params

customerName
string
required

customer organization name

seats
integer
required

number of users

streetAddress
string
required

street address

streetAddress2
string

street address2

city
string
required

city

state
string
required

state

countryCode
string
required

country code

zipCode
string

zip code

packageId
integer
required

package id

dealId
string

deal id

adminEmails
array of strings
required

array of admin emails

ccwDealOwnerEmails
array of strings

array of CCW deal owner emails

Response

Update a Customer

customerIdinteger

customerID

customerNamestring

customer organization name

packageNamestring

name of customer's subscribed package

seatsinteger

number of users

streetAddressstring

street address

streetAddress2string

street address2

citystring

city

statestring

state

countryCodestring

country code

zipCodestring

zip code

packageIdinteger

package id

dealIdstring

deal id

adminEmailsarray

array of admin emails

ccwDealOwnerEmailsarray

array of CCW deal owner emails

createdAtstring

iso8601 timestamp of when customer was created

modifiedAtstring

iso8601 timestamp of when customer was last modified

MSPs

 

/msps/{mspId}/customers

Create a new MspCustomer

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://management.api.umbrella.com/v1/msps/mspId/customers
curl --request POST \
  --url https://management.api.umbrella.com/v1/msps/mspId/customers
var request = require("request");

var options = { method: 'POST',
  url: 'https://management.api.umbrella.com/v1/msps/mspId/customers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/msps/mspId/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://management.api.umbrella.com/v1/msps/mspId/customers");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/msps/mspId/customers"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

mspId
integer
required

The mspID related to this MspCustomer

Body Params

customerName
string
required

customer organization name

seats
integer
required

number of users

Response

Create a new MspCustomer

customerIdinteger

customerID

customerNamestring

customer organization name

seatsinteger

number of users

/msps/{mspId}/customers

Return a list of MspCustomer

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/msps/mspId/customers
curl --request GET \
  --url https://management.api.umbrella.com/v1/msps/mspId/customers
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/msps/mspId/customers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/msps/mspId/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/msps/mspId/customers");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/msps/mspId/customers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

mspId
integer
required

The mspID related to this MspCustomer

Query Params

limit
integer
page
integer

Response

Return a list of MspCustomers

/msps/{mspId}/customers/{customerId}

Return a MspCustomer

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/msps/mspId/customers/customerId
curl --request GET \
  --url https://management.api.umbrella.com/v1/msps/mspId/customers/customerId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/msps/mspId/customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/msps/mspId/customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/msps/mspId/customers/customerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/msps/mspId/customers/customerId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

mspId
integer
required

The mspID related to this MspCustomer

customerId
integer
required

The customerID related to this MspCustomer

Response

Return a MspCustomer

customerIdinteger

customerID

customerNamestring

customer organization name

seatsinteger

number of users

/msps/{mspId}/customers/{customerId}

Delete a MspCustomer

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/msps/mspId/customers/customerId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/msps/mspId/customers/customerId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/msps/mspId/customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/msps/mspId/customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/msps/mspId/customers/customerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/msps/mspId/customers/customerId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

mspId
integer
required

The mspID related to this MspCustomer

customerId
integer
required

The customerID related to this MspCustomer

Response

Delete a MspCustomer

customerIdinteger

customerID

customerNamestring

customer organization name

seatsinteger

number of users

/msps/{mspId}/customers/{customerId}

Update a MspCustomer

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://management.api.umbrella.com/v1/msps/mspId/customers/customerId
curl --request PUT \
  --url https://management.api.umbrella.com/v1/msps/mspId/customers/customerId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://management.api.umbrella.com/v1/msps/mspId/customers/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/msps/mspId/customers/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://management.api.umbrella.com/v1/msps/mspId/customers/customerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/msps/mspId/customers/customerId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

mspId
integer
required

The mspID related to this MspCustomer

customerId
integer
required

The customerID related to this MspCustomer

Body Params

customerName
string
required

customer organization name

seats
integer
required

number of users

Response

Update a MspCustomer

customerIdinteger

customerID

customerNamestring

customer organization name

seatsinteger

number of users

Networks

 

/organizations/{organizationId}/networks

Return a list of Networks

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/networks
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/networks
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/networks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/networks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/networks");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/networks"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Network

Query Params

limit
integer
page
integer

Response

Return a list of Networks

/organizations/{organizationId}/networks/{networkId}

Return a Network

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Network

networkId
integer
required

The network id related to this Network

Response

Return a Network

originIdinteger

origin id

namestring

network name

ipAddressstring

network ip address

prefixLengthinteger

prefix length, must be greater than 28

isDynamicboolean

is dynamic ip

isVerifiedboolean

network verified

statusstring

status

createdAtstring

created at

/organizations/{organizationId}/networks/{networkId}

Delete a Network

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/networks/networkId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Network

networkId
integer
required

The network id related to this Network

Response

Delete a Network

originIdinteger

origin id

namestring

network name

ipAddressstring

network ip address

prefixLengthinteger

prefix length, must be greater than 28

isDynamicboolean

is dynamic ip

isVerifiedboolean

network verified

statusstring

status

createdAtstring

created at

Roaming Computers

 

/organizations/{organizationId}/roamingcomputers

Return a list of RoamingComputers

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this RoamingComputer

Query Params

limit
integer
page
integer
name
string
status
string
lastSyncBefore
date-time
lastSyncAfter
date-time

Response

Return a list of RoamingComputers

/organizations/{organizationId}/roamingcomputers/{roamingComputerId}

Return a RoamingComputer

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this RoamingComputer

roamingComputerId
string
required

The roamingComputerID related to this RoamingComputer

Response

Return a RoamingComputer

originIdinteger

origin id

namestring

roaming computer name

deviceIdstring

roaming computer hex id

typestring

roaming computer type

statusstring

roaming computer status

lastSyncStatusstring

last sync status

lastSyncstring

last sync at

appliedBundleinteger

policy id

hasIpBlockingboolean

ip blocking

versionstring

roaming computer version

osVersionstring

os version

osVersionNamestring

os version name

/organizations/{organizationId}/roamingcomputers/{roamingComputerId}

Update a RoamingComputer

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId
curl --request PUT \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this RoamingComputer

roamingComputerId
string
required

The roamingComputerID related to this RoamingComputer

Body Params

name
string
required

roaming computer name

Response

Update a RoamingComputer

originIdinteger

origin id

namestring

roaming computer name

deviceIdstring

roaming computer hex id

typestring

roaming computer type

statusstring

roaming computer status

lastSyncStatusstring

last sync status

lastSyncstring

last sync at

appliedBundleinteger

policy id

hasIpBlockingboolean

ip blocking

versionstring

roaming computer version

osVersionstring

os version

osVersionNamestring

os version name

/organizations/{organizationId}/roamingcomputers/{roamingComputerId}

Delete a RoamingComputer

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/roamingcomputers/roamingComputerId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this RoamingComputer

roamingComputerId
string
required

The roamingComputerID related to this RoamingComputer

Response

Delete a RoamingComputer

originIdinteger

origin id

namestring

roaming computer name

deviceIdstring

roaming computer hex id

typestring

roaming computer type

statusstring

roaming computer status

lastSyncStatusstring

last sync status

lastSyncstring

last sync at

appliedBundleinteger

policy id

hasIpBlockingboolean

ip blocking

versionstring

roaming computer version

osVersionstring

os version

osVersionNamestring

os version name

Internal Networks

 

/organizations/{organizationId}/internalnetworks

Create a new InternalNetwork

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks
curl --request POST \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks
var request = require("request");

var options = { method: 'POST',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this InternalNetwork

Body Params

name
string
required

internal network label

ipAddress
string
required

internal network ipv4 address

prefixLength
integer
required

prefix length

siteId
integer
required

site id

Response

Create a new InternalNetwork

originIdinteger

origin id

namestring

internal network label

ipAddressstring

internal network ipv4 address

prefixLengthinteger

prefix length

siteNamestring

site name

siteIdinteger

site id

createdAtstring

created at

modifiedAtstring

modified at

/organizations/{organizationId}/internalnetworks

Return a list of InternalNetworks

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this InternalNetwork

Query Params

limit
integer
page
integer

Response

Return a list of InternalNetworks

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

Return an InternalNetwork

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this InternalNetwork

internalNetworkId
integer
required

The internal network id related to this InternalNetwork

Response

Return an InternalNetwork

originIdinteger

origin id

namestring

internal network label

ipAddressstring

internal network ipv4 address

prefixLengthinteger

prefix length

siteNamestring

site name

siteIdinteger

site id

createdAtstring

created at

modifiedAtstring

modified at

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

Update an InternalNetwork

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId
curl --request PUT \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this InternalNetwork

internalNetworkId
integer
required

The internal network id related to this InternalNetwork

Body Params

name
string
required

internal network label

ipAddress
string
required

internal network ipv4 address

prefixLength
integer
required

prefix length

siteId
integer
required

site id

Response

Update an internalNetwork

originIdinteger

origin id

namestring

internal network label

ipAddressstring

internal network ipv4 address

prefixLengthinteger

prefix length

siteNamestring

site name

siteIdinteger

site id

createdAtstring

created at

modifiedAtstring

modified at

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

Delete an internalNetwork

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/internalnetworks/internalNetworkId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this InternalNetwork

internalNetworkId
integer
required

The internal network id related to this InternalNetwork

Response

Delete an internalNetwork

originIdinteger

origin id

namestring

internal network label

ipAddressstring

internal network ipv4 address

prefixLengthinteger

prefix length

siteNamestring

site name

siteIdinteger

site id

createdAtstring

created at

modifiedAtstring

modified at

Virtual Appliances

 

/organizations/{organizationId}/virtualappliances

Return a list of VirtualAppliances

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this VirtualAppliance

Query Params

limit
integer
page
integer

Response

Return a list of VirtualAppliances

/organizations/{organizationId}/virtualappliances/{virtualApplianceId}

Return a VirtualAppliance

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this VirtualAppliance

virtualApplianceId
integer
required

The virtual appliance id related to this VirtualAppliance

Response

Return a VirtualAppliance

originIdinteger

origin id

namestring

virtual appliance name

siteIdinteger

site id

isUpgradableboolean

can upgrade to latest VA version

stateobject
state.connectedToConnectorstring

virtual appliance connected to connector status

state.hasLocalDomainConfiguredstring

virtual appliance has local domain configuration

state.queryFailureRateAcceptablestring

is virtual appliance query failure rate acceptable

state.receivedInternalDNSQueriesstring

has virtual appliance received internal DNS queries

state.redundantWithinSitestring

is virtual appliance redundant within site

state.syncingstring

is virtual appliance syncing

healthstring

virtual appliance health

typestring

virtual appliance type

settingsobject
settings.internalIPsarray

internal IPs

settings.externalIPstring

external IP

settings.hostTypestring

host type

settings.uptimeinteger

uptime in second

settings.isDnscryptEnabledboolean

dnscription enabled

settings.versionstring

virtual appliance version

settings.upgradeErrorstring

upgrade error

settings.domainsarray

domains

settings.lastSyncTimestring

last sync time

createdAtstring

created at

modifiedAtstring

modified at

stateUpdatedAtstring

state updated at

/organizations/{organizationId}/virtualappliances/{virtualApplianceId}

Update a VirtualAppliance

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId
curl --request PUT \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this VirtualAppliance

virtualApplianceId
integer
required

The virtual appliance id related to this VirtualAppliance

Body Params

siteId
integer
required

site id

Response

Update a VirtualAppliance

originIdinteger

origin id

namestring

virtual appliance name

siteIdinteger

site id

isUpgradableboolean

can upgrade to latest VA version

stateobject
state.connectedToConnectorstring

virtual appliance connected to connector status

state.hasLocalDomainConfiguredstring

virtual appliance has local domain configuration

state.queryFailureRateAcceptablestring

is virtual appliance query failure rate acceptable

state.receivedInternalDNSQueriesstring

has virtual appliance received internal DNS queries

state.redundantWithinSitestring

is virtual appliance redundant within site

state.syncingstring

is virtual appliance syncing

healthstring

virtual appliance health

typestring

virtual appliance type

settingsobject
settings.internalIPsarray

internal IPs

settings.externalIPstring

external IP

settings.hostTypestring

host type

settings.uptimeinteger

uptime in second

settings.isDnscryptEnabledboolean

dnscription enabled

settings.versionstring

virtual appliance version

settings.upgradeErrorstring

upgrade error

settings.domainsarray

domains

settings.lastSyncTimestring

last sync time

createdAtstring

created at

modifiedAtstring

modified at

stateUpdatedAtstring

state updated at

/organizations/{organizationId}/virtualappliances/{virtualApplianceId}

Delete a VirtualAppliance

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/virtualappliances/virtualApplianceId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this VirtualAppliance

virtualApplianceId
integer
required

The virtual appliance id related to this VirtualAppliance

Response

Delete a VirtualAppliance

originIdinteger

origin id

namestring

virtual appliance name

siteIdinteger

site id

isUpgradableboolean

can upgrade to latest VA version

stateobject
state.connectedToConnectorstring

virtual appliance connected to connector status

state.hasLocalDomainConfiguredstring

virtual appliance has local domain configuration

state.queryFailureRateAcceptablestring

is virtual appliance query failure rate acceptable

state.receivedInternalDNSQueriesstring

has virtual appliance received internal DNS queries

state.redundantWithinSitestring

is virtual appliance redundant within site

state.syncingstring

is virtual appliance syncing

healthstring

virtual appliance health

typestring

virtual appliance type

settingsobject
settings.internalIPsarray

internal IPs

settings.externalIPstring

external IP

settings.hostTypestring

host type

settings.uptimeinteger

uptime in second

settings.isDnscryptEnabledboolean

dnscription enabled

settings.versionstring

virtual appliance version

settings.upgradeErrorstring

upgrade error

settings.domainsarray

domains

settings.lastSyncTimestring

last sync time

createdAtstring

created at

modifiedAtstring

modified at

stateUpdatedAtstring

state updated at

Sites

 

/organizations/{organizationId}/sites

Create a new Site

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://management.api.umbrella.com/v1/organizations/organizationId/sites
curl --request POST \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/sites
var request = require("request");

var options = { method: 'POST',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/sites' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/sites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://management.api.umbrella.com/v1/organizations/organizationId/sites");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/sites"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Site

Body Params

name
string
required

site name

Response

Create a new Site

originIdinteger

origin id

namestring

site name

siteIdinteger

site id

isDefaultboolean

indicates whether the site is default or not

typestring

site type

internalNetworkCountinteger

number of internal networks attached to this site

vaCountinteger

number of virtual appliances attached to this site

modifiedAtstring

created at

createdAtstring

created at

/organizations/{organizationId}/sites

Return a list of Sites

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/sites
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/sites
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/sites' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/sites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/sites");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/sites"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Site

Query Params

limit
integer
page
integer

Response

Return a list of Sites

/organizations/{organizationId}/sites/{siteId}

Return a Site

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Site

siteId
integer
required

The siteID related to this Site

Response

Return a Site

originIdinteger

origin id

namestring

site name

siteIdinteger

site id

isDefaultboolean

indicates whether the site is default or not

typestring

site type

internalNetworkCountinteger

number of internal networks attached to this site

vaCountinteger

number of virtual appliances attached to this site

modifiedAtstring

created at

createdAtstring

created at

/organizations/{organizationId}/sites/{siteId}

Update a Site

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId
curl --request PUT \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId
var request = require("request");

var options = { method: 'PUT',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Site

siteId
integer
required

The siteID related to this Site

Body Params

name
string
required

site name

Response

Update a Site

originIdinteger

origin id

namestring

site name

siteIdinteger

site id

isDefaultboolean

indicates whether the site is default or not

typestring

site type

internalNetworkCountinteger

number of internal networks attached to this site

vaCountinteger

number of virtual appliances attached to this site

modifiedAtstring

created at

createdAtstring

created at

/organizations/{organizationId}/sites/{siteId}

Delete a Site

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/sites/siteId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Site

siteId
integer
required

The siteID related to this Site

Response

Delete a Site

originIdinteger

origin id

namestring

site name

siteIdinteger

site id

isDefaultboolean

indicates whether the site is default or not

typestring

site type

internalNetworkCountinteger

number of internal networks attached to this site

vaCountinteger

number of virtual appliances attached to this site

modifiedAtstring

created at

createdAtstring

created at

Users

 

/organizations/{organizationId}/users

Create a new User

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://management.api.umbrella.com/v1/organizations/organizationId/users
curl --request POST \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/users
var request = require("request");

var options = { method: 'POST',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://management.api.umbrella.com/v1/organizations/organizationId/users");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/users"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this User

Body Params

firstname
string
required

user first name

lastname
string
required

user last name

email
string
required

user email

password
string
required

user password

roleId
integer
required

role id

timezone
string
required

user timezone name

Response

Create a new User

idinteger

user id

firstnamestring

user first name

lastnamestring

user last name

emailstring

user email

rolestring

user role name

roleIdinteger

role id

timezonestring

user timezone name

statusstring

user status

lastLoginTimestring

user last login time

twoFactorEnableboolean

is two-factor authentication enabled

/organizations/{organizationId}/users

Return a list of Users

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/users
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/users
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/users");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this User

Query Params

limit
integer
page
integer

Response

Return a list of Users

/organizations/{organizationId}/users/{userId}

Return a User

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/users/userId
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/users/userId
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/users/userId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/users/userId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/users/userId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/users/userId"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this User

userId
integer
required

The userID related to this User

Response

Return a User

idinteger

user id

firstnamestring

user first name

lastnamestring

user last name

emailstring

user email

rolestring

user role name

roleIdinteger

role id

timezonestring

user timezone name

statusstring

user status

lastLoginTimestring

user last login time

twoFactorEnableboolean

is two-factor authentication enabled

/organizations/{organizationId}/users/{userId}

Delete a User

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://management.api.umbrella.com/v1/organizations/organizationId/users/userId
curl --request DELETE \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/users/userId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/users/userId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/users/userId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://management.api.umbrella.com/v1/organizations/organizationId/users/userId");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/users/userId"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this User

userId
integer
required

The userID related to this User

Response

Delete a User

idinteger

user id

firstnamestring

user first name

lastnamestring

user last name

emailstring

user email

rolestring

user role name

roleIdinteger

role id

timezonestring

user timezone name

statusstring

user status

lastLoginTimestring

user last login time

twoFactorEnableboolean

is two-factor authentication enabled

Roles

 

/organizations/{organizationId}/roles

Return a list of Roles

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://management.api.umbrella.com/v1/organizations/organizationId/roles
curl --request GET \
  --url https://management.api.umbrella.com/v1/organizations/organizationId/roles
var request = require("request");

var options = { method: 'GET',
  url: 'https://management.api.umbrella.com/v1/organizations/organizationId/roles' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://management.api.umbrella.com/v1/organizations/organizationId/roles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://management.api.umbrella.com/v1/organizations/organizationId/roles");

xhr.send(data);
import requests

url = "https://management.api.umbrella.com/v1/organizations/organizationId/roles"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

organizationId
integer
required

The organizationID related to this Role

Query Params

limit
integer
page
integer

Response

Return a list of Roles