Delete multiple IP scopes in a single request

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 multiple IP scopes identified by their boundary IDs.

Endpoints

Request URL

https://{serverurl}/dcapi/som/ip-scopes

Scope

DesktopCentralCloud.SOM.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/ipScopeDetail.v1+jsonapplication/ipScopeDetail.v1+jsonCopied!
AcceptstringMandatory
application/ipScopeDeletedStatus.v1+jsonapplication/ipScopeDeletedStatus.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
ipScopeIDsarrayMandatory

Array of IP scope boundary IDs to delete (maximum 1000 per request), get ip scope's unique identified(boundaryID) from IP Scopes api

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomains/dcapi/som/ip-scopes \
  --header 'Accept: application/ipScopeDeletedStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/ipScopeDetail.v1+json' \
  --data '{"ipScopeIDs":["1","2","3"]}'

Sample Request Body

Delete multiple IP scopes

Copied!
  {
    "ipScopeIDs": [
      "1",
      "2",
      "3"
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

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

Array of IP scope boundary IDs that were successfully deleted

notDeletedIPScopeIDsarray

Array of IP scope boundary IDs that could not be deleted (e.g., invalid ID or already deleted)

messagestring

Descriptive message providing details about the bulk delete outcome

statusboolean

Indicates whether the bulk delete operation completed successfully

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

Sample Response: HTTP 200

All IP scopes deleted successfully

Copied!
  {
    "deletedIPScopeIDs": [
      "1",
      "2",
      "3"
    ],
    "message": "Selected IP scope(s) were successfully deleted.",
    "notDeletedIPScopeIDs": [],
    "status": true
  }
                
Show full

Some IP scopes could not be deleted

Copied!
  {
    "deletedIPScopeIDs": [
      "1",
      "2"
    ],
    "message": "Selected IP scope(s) were successfully deleted.",
    "notDeletedIPScopeIDs": [
      "123"
    ],
    "status": true
  }
                
Show full

Sample Response: HTTP 412

IP scope IDs list is empty

Copied!
  {
    "errorCode": "30022",
    "message": "Required IP scope parameters are missing",
    "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.