# Retrieve details of a specific IP scope Retrieves details of a specific IP scope by its boundary ID including type (range or subnet), addresses, and description. ## Endpoint `GET /dcapi/som/ip-scopes/{ip_scope_id}` ## Request URL `https://{server-hostname}:8383/dcapi/som/ip-scopes/{ip_scope_id}` ### Scope `SOM.READ` ### Header `Authorization: d92d4xxxxxxxxxxxxx15f52` ## Request Parameters ### Request Headers | Parameter | Type | Required | Value | |---|---|---|---| | Accept | string | Mandatory | `application/ipScopeDetail.v1+json` | ### Path Parameters | Parameter | Type | Required | Description | |---|---|---|---| | ip_scope_id | string | Mandatory | A unique identifier assigned to the IP Scope. Refer to the boundaryID value obtained from the response of [IP Scope Details](https://www.manageengine.com/products/desktop-central/help/api/onpremise/ipscopes-list-ipscopes.html) API. | ## Sample Request ### Curl ```curl curl --request GET \ --url https://appdomain/dcapi/som/ip-scopes/{ip_scope_id} \ --header 'Accept: application/ipScopeDetail.v1+json' \ --header 'Authorization: d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 Response Body: `application/json` | Attribute | Type | Description | |---|---|---| | boundaryID | long | Unique identifier of the IP scope boundary | | remoteOfficeID | long | Identifier of the remote office this IP scope is assigned to. Fetch details of the remote office from this [API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remoteoffices_getremoteoffice.html). | | ipScopeType | string | Type of IP scope definition: `range` (start-to-end IP address range) or `subnet` (network address with subnet mask) | | subnetClass | string | Subnet class classification (A, B, or C) based on the network address. Present only when ipScopeType is `subnet`. | | networkAddress | string | Indicates the network address of the subnet (for example, `192.168.1.0`). Present only when ipScopeType is `subnet`. | | subnetMask | string | Subnet mask for the network (e.g., `255.255.255.0`). Present only when ipScopeType is `subnet`. | | startIPAddress | string | Indicates the starting IP address of the configured range (for example, `10.0.0.1`). Present only when ipScopeType is `range`. | | endIPAddress | string | Indicates the ending IP address of the configured range (for example, `10.0.0.254`). Present only when ipScopeType is `range`. | | description | string | Administrator-provided description for the IP scope. | ### HTTP Code 404 Response Body: `application/json` | Attribute | Type | Description | |---|---|---| | statusCode | string | HTTP status code (404) | | errorCode | string | Error code identifying the resource that was not found | | message | string | Error message describing the missing resource | ## Possible Response Codes | Code | Type | |---|---| | 200 | HTTP code | | 404 | HTTP code | ## Sample Response: HTTP 200 ### IP Scope With Range Type ```json { "boundaryID": "1", "description": "HQ Network Range", "remoteOfficeID": "101", "ipScopeType": "range", "startIPAddress": "192.168.1.1", "endIPAddress": "192.168.1.254" } ``` ### IP Scope With Subnet Type ```json { "subnetClass": "C", "boundaryID": "2", "description": "Branch Office Subnet", "remoteOfficeID": "102", "ipScopeType": "subnet", "subnetMask": "255.255.255.0", "networkAddress": "10.0.0.0" } ``` ## Sample Response: HTTP 404 ### IP Scope Not Found ```json { "errorCode": "30024", "message": "IP scope does not exist", "statusCode": 404 } ``` ## Rate Limit ![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png) **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.