Skip to main content

Managing Administration Using API

This article provides information on performing administration tasks in Zscaler Digital Experience (ZDX) using APIs. All APIs are rate limited. To learn more, see ZDX API Rate Limits.

Retrieving Department Details

To get the details of all the configured departments, send a GET request to the endpoint /administration/departments. Provide the following in the request:

  • from: The timestamp, in epoch, from when the data is displayed.
  • to: The timestamp, in epoch, till when the data is displayed.

For example, in Python:

payload = {
"from":1493967600000,
"to":1496645999999
}

The request body can also include the search attribute to get the data for a specific department ID or name.

Example response:

{
"id": 38745231567,
"name": "Engineering"
}

A successful response returns code 200. To learn more, see ZDX API Codes.

Retrieving Location Details

To get the details of all the configured Zscaler locations, send a GET request to the endpoint /administration/locations. Provide the following in the request:

  • from: The timestamp, in epoch, from when the data is displayed.
  • to: The timestamp, in epoch, till when the data is displayed.

For example, in Python:

payload = {
"from":1493967600000,
"to":1496645999999
}

The request body can also include the search attribute to get the data for a specific location ID or name.

Sample response:

{
"id": 72840124,
"name": "US-BHE23-CBR - San Francisco"
}

A successful response returns code 200. To learn more, see ZDX API Codes.