Retrieve details of a specific IP scope

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 details of a specific IP scope by its boundary ID including type (range or subnet), addresses, and description.

Request URL

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

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

ip_scope_idstringMandatory

A unique identifier assigned to the IP Scope. Refer to the boundaryID value obtained from the response of IP Scope Details Api.

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide 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.

- HTTP code 404

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusCodestring

HTTP status code (404)

errorCodestring

Error code identifying the resource that was not found

messagestring

Error message describing the missing resource

Possible Response Codes

200HTTP code
404HTTP code

Sample Response: HTTP 200

IP scope with range type

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

IP scope with subnet type

Copied!
  {
    "subnetClass": "C",
    "boundaryID": "2",
    "description": "Branch Office Subnet",
    "remoteOfficeID": "102",
    "ipScopeType": "subnet",
    "subnetMask": "255.255.255.0",
    "networkAddress": "10.0.0.0"
  }
                
Show full

Sample Response: HTTP 404

IP scope not found

Copied!
  {
    "errorCode": "30024",
    "message": "IP scope does not exist",
    "statusCode": 404
  }
                
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.