Skip to main content

GET /ipDuplication

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

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/ipDuplication

Query parameters​

ParametersRequired / OptionalDescription
IPs={IP_addresses}RequiredList 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​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe 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.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
duplicateInStringIdentifies 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.

IPStringIP address
availableBooleanIndicates 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
   }
]