Delete a 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

Deletes a remote office (branch office) identified by ID.

Request URL

https://{server-hostname}:8383/dcapi/som/remote-offices/{remote_office_id}

Scope

SOM.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/remoteOfficeDeletedStatus.v1+jsonapplication/remoteOfficeDeletedStatus.v1+jsonCopied!

- Path Parameters

remote_office_idstringMandatory

Unique identifier for the remote office, get remote office id from Get Remote Offices resource_id field in response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomain/dcapi/som/remote-offices/{remote_office_id} \
  --header 'Accept: application/remoteOfficeDeletedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

true if the remote office was deleted successfully

- 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 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
404HTTP code
412HTTP code

Sample Response: HTTP 200

Remote office deleted

Copied!
  {
    "status": true
  }
                
Show full

Sample Response: HTTP 400

Cannot delete the local office

Copied!
  {
    "errorCode": "30059",
    "message": "Local office cannot be deleted",
    "statusCode": 400
  }
                
Show full

Sample Response: HTTP 404

Remote office not found

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

Sample Response: HTTP 412

Remote office is mapped with SoM policy targets

Copied!
  {
    "errorCode": "30066",
    "message": "Remote office cannot be removed as it is mapped with SoM policy targets",
    "statusCode": 412
  }
                
Show full

Remote office is configured as AD connector branch

Copied!
  {
    "errorCode": "30044",
    "message": "Remote office configured as AD connector branch cannot be deleted",
    "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.