Move computers to a different remote office

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

Moves one or more computers from their current remote office to a different remote office.

Request URL

https://{server-hostname}:8383/dcapi/som/computers/moveRemoteOffice

Scope

SOM.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/computersToMoveRO.v1+jsonapplication/computersToMoveRO.v1+jsonCopied!
AcceptstringMandatory
application/computerMoveStatus.v1+jsonapplication/computerMoveStatus.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
computerIDsJSON ArrayMandatory

Array of computer resource IDs to move to the target remote office, get resource ids from Get Computers

Show Sub-Attributes
string
remoteOfficeIDstringOptional

Identifier of the target remote office to move the computers into. Fetch available IDs from Get Remote Offices

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/dcapi/som/computers/moveRemoteOffice \
  --header 'Accept: application/computerMoveStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/computersToMoveRO.v1+json' \
  --data '{"computerIDs":["4001","4002","4003","4004"],"remoteOfficeID":501}'

Sample Request Body

Move computers to a different remote office

Copied!
  {
    "computerIDs": [
      "4001",
      "4002",
      "4003",
      "4004"
    ],
    "remoteOfficeID": 501
  }
                
Show full

Response Parameters

- HTTP code 200

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

Indicates whether the remote office move operation was accepted and initiated successfully

messagestring

Status indicator for the move operation: 'YetToInstall' when the agent is not yet installed on the target, 'NSRequired' when Notification Service is required to complete the move

- HTTP code 400

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

HTTP status code (400)

errorCodestring

API-specific error code identifying the validation failure

messagestring

Error message describing the validation failure

- HTTP code 401

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

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- 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

- HTTP code 412

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

HTTP status code (412)

errorCodestring

Precondition failed error code identifying the business logic violation

messagestring

Error message describing the precondition failed while processing request

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
404HTTP code
412HTTP code

Sample Response: HTTP 200

Move initiated

Copied!
  {
    "message": "YetToInstall",
    "status": true
  }
                
Show full

Sample Response: HTTP 400

Missing or empty computerIDs in request

Copied!
  {
    "errorCode": "20006",
    "message": "Resource IDs are not present in the request",
    "statusCode": 400
  }
                
Show full

Another move operation is already in progress

Copied!
  {
    "errorCode": "30041",
    "message": "Agent move operation is already running",
    "statusCode": 400
  }
                
Show full

Sample Response: HTTP 401

Custom group scope user is not allowed to move computers

Copied!
  {
    "errorCode": "1001",
    "message": "Unauthorized",
    "statusCode": 401
  }
                
Show full

Sample Response: HTTP 404

Target remote office not found

Copied!
  {
    "errorCode": "30028",
    "message": "Remote office not found",
    "statusCode": 404
  }
                
Show full

Sample Response: HTTP 412

Non-admin user cannot access the requested computers

Copied!
  {
    "errorCode": "20005",
    "message": "Selected computers are not accessible",
    "statusCode": 412
  }
                
Show full

Some computers are not managed by the server

Copied!
  {
    "errorCode": "30007",
    "message": "All resources are not managed computers",
    "statusCode": 412
  }
                
Show full

All agents are already in the target remote office

Copied!
  {
    "errorCode": "30040",
    "message": "All agents are already in the target remote office",
    "statusCode": 412
  }
                
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.