Sites
The Umbrella Sites API enables you to:
- Create a site
- List the sites
- Get a site
- Update a site
- Delete a site
Create a Site
POST /organizations/{organizationId}/sites
Request Body Fields
| Name | Type | Description |
|---|---|---|
| name | string | Specifies the name of the site. Required |
Request
curl -i -X POST "https://management.api.umbrella.com/v1/organizations/{organizationId}/sites" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json' \
-d '{ "name": "Site name" }'
Response
Sample response (200, OK):
{
"originId": 1234,
"name": "Name of the site",
"siteId": 14,
"isDefault": false,
"type": "Type of site",
"internalNetworkCount": 10,
"vaCount": 2,
"modifiedAt": "2020-03-09T22:18:26.625Z",
"createdAt": "2020-03-09T22:18:26.625Z"
}
List Sites
GET /organizations/{organizationId}/sites
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. |
Request
curl -i -X GET "https://management.api.umbrella.com/v1/organizations/{organizationId}/sites" \
-H 'Authorization: Basic %YourEncodedKeySecret%' \
-H 'Content-Type: application/json'
Response
Sample response (200, OK):
[
{
"originId": 1234,
"name": "Name of the site",
"siteId": 14,
"isDefault": false,
"modifiedAt": "2020-03-09T22:18:26.625Z",
"createdAt": "2020-03-09T22:18:26.625Z"
}
]