REST Resources

/api/space/device-management/devices/{id}/modify-device-target-ip

The following operation is supported on this resource:

  • POST - Change the IP of the device using which space is communicating with and re-establish the connection - Change IP of device
POST /devices/{id}/modify-device-target-ipVersion 1

Change the IP of the device using which space is communicating with and re-establish the connection.

Sample Usage

This API makes an asynchronous method call; so, you can optionally specify queue and schedule parameters:

POST /devices/{id}/modify-device-target-ip?queue=<queue>&schedule=<schedule>


Note: The queue URL denoted by <queue> must have been created already.


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPathID of the device Y
    queueQueue URLQueryA fully qualified queue URL, where job progress notifications will be sent (See Asynchronous API Usage)N
    schedulecron-like-expressionQuerySchedule this API in the future, by specifying a cron-like-expression (See Job Scheduling)N
  • Sample Input XML:
    <modify-device-target-ip>
         <new-ip-address>2.2.2.2</new-ip-address>
    </modify-device-target-ip>

  • Sample Output XML:
    <task href="/api/space/job-management/jobs/3997704">
      <id>3997704</id>
    </task>

  • Sample Input JSON:
    {
       "modify-device-target-ip" : {
         "new-ip-address" : "2.2.2.2" ,
       }
    }

  • Sample Output JSON:
    {
      "task": {
        "@href":"/api/space/job-management/jobs/3997704",
        "id":3997704
      }
    }

  • Access Control

    The following capabilities are required to access this API: ModifyConnection