Retrieve paginated list of IP scopes

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves a paginated list of all IP scopes for the customer

Endpoints

Request URL

https://{serverurl}/dcapi/som/ip-scopes

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/allIPScopeDetails.v1+jsonapplication/allIPScopeDetails.v1+jsonCopied!

- Query Parameters

pageintegerOptional

Specifies the page number to retrieve. Default is 1

sizestringOptional

Specifies the maximum number of items to return per page. The default value is 25. A maximum of 1000 records can be retrieved in a single request

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/som/ip-scopes \
  --header 'Accept: application/allIPScopeDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
ipScopesJSON Array

Array of IP scope objects. Each object contains the boundary definition (range or subnet) and its associated remote office

Show Sub-Attributes
JSON Object
Show Sub-Attributes
boundaryIDlong

Unique identifier of the IP scope boundary

remoteOfficeIDlong

Identifier of the remote office this IP scope is assigned to. Fetch details of the remote office from this api

ipScopeTypestring

Type of IP scope definition: 'range' (start-to-end IP address range) or 'subnet' (network address with subnet mask)

subnetClassstring

Subnet class classification (A, B, or C) based on the network address. Present only when ipScopeType is 'subnet'

networkAddressstring

Indicates the network address of the subnet (for example, 192.168.1.0). Present only when ipScopeType is 'subnet'

subnetMaskstring

Subnet mask for the network (e.g., '255.255.255.0'). Present only when ipScopeType is 'subnet'

startIPAddressstring

Indicates the starting IP address of the configured range (for example, 10.0.0.1). Present only when ipScopeType is 'range'

endIPAddressstring

Indicates the ending IP address of the configured range (for example, 10.0.0.254). Present only when ipScopeType is 'range'

descriptionstring

Administrator-provided description for the IP scope.

Response Headers


X-Total-Countstring

Total number of IP scopes available

Possible Response Codes

200HTTP code
204HTTP code

Sample Response: HTTP 200

IP scopes found

Copied!
  {
    "ipScopes": [
      {
        "boundaryID": 1,
        "description": "HQ Network Range",
        "remoteOfficeID": 101,
        "ipScopeType": "range",
        "startIPAddress": "192.168.1.1",
        "endIPAddress": "192.168.1.254"
      }
    ]
  }
                
Show full

Sample Response: HTTP 204

Copied!
204 No Content
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.