GET /ipDuplication

Use this method to check whether the specified IP addresses are duplicate in the same subnet.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/ipDuplication

Query parameters

Parameters Required / Optional Description
IPs={IP_addresses} Required List of IP addresses to check for duplication
The following example checks whether the two IP addresses are duplicate.
GET https://192.0.2.0/ipDuplication?IPs=10.243.9.18,10.243.3.171

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401 Unauthorized The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404 Not found A specified resource cannot be found. A descriptive error message is returned in the response body.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
duplicateIn String Identifies the environment in which the IP address is duplicate. This can be one of the following values.
  • network. A duplicate IP address was found in the same network.

  • managed. A managed device uses the same IP address.

  • in_managed. A device that is currently in the management process uses the same IP address.

IP String IP address
available Boolean Indicates whether the IP address is not duplicates and can be used. This can be one of the following values.
  • true. The IP address is not duplicate and can be use.

  • false. The IP address is duplicate and cannot be use.

The following example is returned if the request is successful.
[
   {
      "duplicateIn": "network",
      "IP": "10.243.3.170",
      "available": false
   },
   …,
   {
      "IP": "10.243.3.171",
      "available": true
   }
]