Skip to main content

Configuring Zscaler Virtual IP Address Ranges Using API

This article provides information on managing Zscaler virtual IP address ranges using APIs. All APIs are rate limited. To learn more, see Adding IP Ranges and ZPA API Rate Limits.

Getting the IP Address Range by Page and Page Size

To get the IP address range details by page and page size:

  1. Send a POST request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ipRanges/search.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/72057594037927936/v2/ipRanges/search.
  3. Include the request headers to provide information about the request context:
    • Content-Type: application/json
    • Authorization: Bearer <access_token>
  4. Use the following JSON payload.

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

JSON Payload​

{
  "sortBy": {
    "sortName": "string",
    "sortOrder": "string"
  },
  "filterBy": [
    {
      "filterName": "string",
      "operator": "string",
      "values": [
        "string"
      ],
      "commaSepValues": "string"
    }
  ],
  "pageBy": {
    "page": "string",
    "pageSize": "string"
  }
}

Example JSON Payload​

{
  "filterBy": [
    {
      "filterName": "IP address",
      "operator": "LIKE",
      "values": [
        "10.0.0.0"
      ],
      "commaSepValues": "string"
    }
  ],
  "pageBy": {
    "page": "1",
    "pageSize": "20",
    "validPage": 0,
    "validPageSize": 0
  }
}

Example Response​

 {
  "totalPages": "2",
  "totalCount": "21",
  "list": [
    {
      "id": "72057594038636775",
      "modifiedTime": "1675179304",
      "creationTime": "1675178886",
      "modifiedBy": "72057594037957297",
      "isDeleted": "0",
      "customerId": "72057594037927936",
      "name": "TempDis",
      "description": "s",
      "ipRangeBegin": "10.1.1.1",
      "ipRangeEnd": "10.1.1.40",
      "latitudeInDb": "28.7040592",
      "longitudeInDb": "77.10249019999999",
      "location": "Delhi, India",
      "countryCode": "IN",
      "enabled": true,
      "totalIps": "40",
      "sccmFlag": false
    },
    {
      "id": "72057594038642797",
      "modifiedTime": "1679431340",
      "creationTime": "1679330645",
      "modifiedBy": "72057594038078999",
      "isDeleted": "0",
      "customerId": "72057594037927936",
      "name": "test",
      "ipRangeBegin": "172.16.255.1",
      "ipRangeEnd": "172.16.255.30",
      "latitudeInDb": "37.7749295",
      "longitudeInDb": "-122.4194155",
      "location": "San Francisco, CA, USA",
      "countryCode": "US",
      "enabled": true,
      "totalIps": "30",
      "sccmFlag": false
    },
    {
      "id": "72057594038624863",
      "modifiedTime": "1679432841",
      "creationTime": "1669363443",
      "modifiedBy": "72057594038078999",
      "isDeleted": "0",
      "customerId": "72057594037927936",
      "name": "disabled ip range test",
      "ipRangeBegin": "10.0.0.10",
      "ipRangeEnd": "10.0.0.100",
      "enabled": true,
      "totalIps": "91",
      "sccmFlag": false
    }
  ]
}

Getting Details of All IP Address Ranges

To get details of all IP address ranges:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ipRanges.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/72057594037927936/v2/ipRanges.

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

Example Response​

[
  {
    "id": "72057594038636775",
    "modifiedTime": "1675179304",
    "creationTime": "1675178886",
    "modifiedBy": "72057594037957297",
    "isDeleted": "0",
    "customerId": "72057594037927936",
    "name": "Example IP Address Range",
    "description": "s",
    "ipRangeBegin": "10.1.1.1",
    "ipRangeEnd": "10.1.1.40",
    "latitudeInDb": "28.7040592",
    "longitudeInDb": "77.10249019999999",
    "location": "Delhi, India",
    "countryCode": "IN",
    "enabled": true,
    "totalIps": "40",
    "sccmFlag": false
  },
  {
    "id": "72057594038642797",
    "modifiedTime": "1679431340",
    "creationTime": "1679330645",
    "modifiedBy": "72057594038078999",
    "isDeleted": "0",
    "customerId": "72057594037927936",
    "name": "Example IP Address Range 2",
    "ipRangeBegin": "10.90.255.1",
    "ipRangeEnd": "10.90.255.30",
    "latitudeInDb": "37.7749295",
    "longitudeInDb": "-122.4194155",
    "location": "San Francisco, CA, USA",
    "countryCode": "US",
    "enabled": true,
    "totalIps": "30",
    "sccmFlag": false
  }
]

Getting Details for a Particular IP Address Range

To get details for a particular IP address range:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ipRanges/{ipRangeId}.

  2. Provide the following in the request endpoint:

    • customerId: The ZPA tenant ID of the customer.
    • ipRangeId: The unique identifier of the IP address range.

    For example: /mgmtconfig/v1/admin/customers/72057594037927936/v2/ipRanges/72057594038636775.

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

Example Response​

{
  "id": "72057594038636775",
  "modifiedTime": "1675179304",
  "creationTime": "1675178886",
  "modifiedBy": "72057594037957297",
  "isDeleted": "0",
  "customerId": "72057594037927936",
  "name": "Example IP Address Range",
  "description": "s",
  "ipRangeBegin": "10.1.1.1",
  "ipRangeEnd": "10.1.1.40",
  "latitudeInDb": "28.7040592",
  "longitudeInDb": "77.10249019999999",
  "location": "Delhi, India",
  "countryCode": "IN",
  "enabled": true,
  "totalIps": "40",
  "sccmFlag": false
}

Adding a New IP Address Range

To add a new IP address range:

  1. Send a POST request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ipRanges.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/72057594037927936/v2/ipRanges.
  3. Include the request headers to provide information about the request context:
    • Content-Type: application/json
    • Authorization: Bearer <access_token>
  4. Use the following JSON payload and provide the following:
    • name: The name of IP address range.
    • ipRangeBegin: The beginning IP address range. The beginning IP address range must be less than the ending IP address range. The subnetCidr field is not required if ipRangeBegin or ipRangeEnd fields are passed.
    • ipRangeEnd: The ending IP address range. The ending IP address range must be greater than the beginning IP address range. The subnetCidr field is not required if ipRangeBegin or ipRangeEnd fields are passed.
    • subnetCidr: The IP address subnet in Classless Inter-Domain Routing (CIDR) notation used for server-to-client connectivity. The ipRangeBegin or ipRangeEnd fields are not required if subnetCidr is passed.
    • location: The location of the IP address range.
    • latitudeInDb: The latitude coordinate for the location of the IP address range.
    • longitudeInDb: The longitude coordinate for the location of the IP address range.
    • sccmFlag: Indicates if the location hint is sent along with a Zscaler IP address to Zscaler Client Connector if it is configured. If Zscaler Client Connector receives the location hint, Zscaler Client Connector creates a pseudo network adapter and applies the location hint to the name of the adapter for the System Center Configuration Manager (SCCM) location boundary.
    • enabled: Indicates if the IP address range is enabled (true) or disabled (false).

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

JSON Payload​

 {
  "name": "string",
  "description": "string",
  "ipRangeBegin": "string",
  "ipRangeEnd": "string",
  "subnetCidr": "string",
  "latitudeInDb": "string",
  "longitudeInDb": "string",
  "location": "string",
  "countryCode": "string",
  "enabled": true,
  "sccmFlag": true,
  "locationHint": "string"
}

Example JSON Payload​

 {
   "name":"Example IP Address Range",
   "enabled":true,
   "ipRangeBegin":"194.158.10.0",
   "ipRangeEnd":"194.158.15.0",
   "description":"Example Description",
   "sccmFlag":false,
   "latitudeInDb":37.7749295,
   "longitudeInDb":-122.4194155,
   "countryCode":"US",
   "location":"San Francisco, CA, USA"
}

Example Response​

 {
    "id": "72057594038900885",
    "modifiedTime": "1752776656",
    "creationTime": "1752776656",
    "modifiedBy": "72057594038040687",
    "isDeleted": "0",
    "customerId": "72057594037927936",
    "name": "Example IP Address Range",
    "description": "Example Description",
    "ipRangeBegin": "194.158.10.0",
    "ipRangeEnd": "194.158.15.0",
    "latitudeInDb": "37.7749295",
    "longitudeInDb": "-122.4194155",
    "location": "San Francisco, CA, USA",
    "countryCode": "US",
    "enabled": true,
    "totalIps": "1281",
    "sccmFlag": false
}

Updating an IP Address Range

To update an existing IP address range:

  1. Send a PUT request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ipRanges/{ipRangeId}.

  2. Provide the following in the request endpoint:

    • customerId: The ZPA tenant ID of the customer.
    • ipRangeId: The unique identifier of the IP address range.

    For example: /mgmtconfig/v1/admin/customers/72057594037927936/v2/ipRanges/72057594038636775.

  3. Include the request headers to provide information about the request context:

  • Content-Type: application/json
  • Authorization: Bearer <access_token>
  1. Use the following JSON payload and provide the following:
    • name: The name of IP address range.
    • ipRangeBegin: The beginning IP address range. The beginning IP address range must be less than the ending IP address range. The subnetCidr field is not required if ipRangeBegin or ipRangeEnd fields are passed.
    • ipRangeEnd: The ending IP address range. The ending IP address range must be greater than the beginning IP address range. The subnetCidr field is not required if ipRangeBegin or ipRangeEnd fields are passed.
    • subnetCidr: The IP address subnet in Classless Inter-Domain Routing (CIDR) notation used for server-to-client connectivity. The ipRangeBegin or ipRangeEnd fields are not required if subnetCidr is passed.
    • location: The location of the IP address range.
    • latitudeInDb: The latitude coordinate for the location of the IP address range.
    • longitudeInDb: The longitude coordinate for the location of the IP address range.
    • sccmFlag: Indicates if the location hint is sent along with a Zscaler IP address to Zscaler Client Connector if it is configured. If Zscaler Client Connector receives the location hint, Zscaler Client Connector creates a pseudo network adapter and applies the location hint to the name of the adapter for the System Center Configuration Manager (SCCM) location boundary.
    • enabled: Indicates if the IP address range is enabled (true) or disabled (false).

A successful response returns code 204, meaning the IP address range is updated. To learn more, see ZPA API Codes.

Example JSON Payload​

  {
  "name": "string",
  "description": "string",
  "ipRangeBegin": "string",
  "ipRangeEnd": "string",
  "subnetCidr": "string",
  "latitudeInDb": "string",
  "longitudeInDb": "string",
  "location": "string",
  "countryCode": "string",
  "enabled": true,
  "sccmFlag": true,
  "locationHint": "string"
}

Deleting an IP Address Range

To delete an existing IP address range:

  1. Send a DELETE request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/v2/ipRanges/{ipRangeId}.

  2. Provide the following in the request endpoint:

    • customerId: The ZPA tenant ID of the customer.
    • ipRangeId: The unique identifier of the IP address range.

    For example: /mgmtconfig/v1/admin/customers/72057594037927936/v2/ipRanges/72057594038636775.

A successful response returns code 200, meaning the IP address range is deleted. To learn more, see ZPA API Codes.

Adding Field Descriptions

The following table includes available fields you can use for the IP address range API use cases:

FieldDescriptionRequiredValue
enabledIndicates if the IP address range is enabled (true) or disabled (false)YesDefault: true
Boolean: true, false
ipRangeBeginThe beginning IP address range. The beginning IP address range must be less than the ending IP address range. The subnetCidr field is not required if ipRangeBegin or ipRangeEnd fields are passed.YesString
ipRangeEndThe ending IP address range. The ending IP address range must be greater than the beginning IP address range. The subnetCidr field is not required if ipRangeBegin or ipRangeEnd fields are passed.YesString
latitudeInDbThe latitude coordinate for the location of the IP address rangeYesString
locationThe location of the IP address rangeYesString
locationHintThe location hint to be sent along with a Zscaler virtual IP address to Zscaler Client Connector if it is configured. This field is required if the sccmFlag field is set to true.NoString
longitudeInDbThe longitude coordinate for the location of the IP address rangeYesString
nameThe name of the IP address rangeYesString
sccmFlagIndicates if the location hint is sent along with a Zscaler virtual IP address to Zscaler Client Connector if it is configured. If Zscaler Client Connector receives the location hint, Zscaler Client Connector creates a pseudo network adapter and applies the location hint to the name of the adapter for the System Center Configuration Manager (SCCM) location boundary.YesDefault: false
Boolean: true, false
subnetCidrThe IP address subnet in Classless Inter-Domain Routing (CIDR) notation used for server-to-client connectivity. The ipRangeBegin or ipRangeEnd fields are not required if subnetCidr is passed.YesString