Update an existing IP scope

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

Updates an existing IP scope identified by boundary ID. Supports range and subnet types.

Request URL

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

Scope

DesktopCentralCloud.SOM.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

ip_scope_idstringMandatory

A unique identifier assigned to the IP Scope. Refer to the boundaryID value obtained from the response of IP Scope Details Api.

- Request Body

application/json
JSON Object
Hide Sub-Attributes
remoteOfficeIDstringOptional

Unique Identifier of the remote office this IP scope will assigned to. Fetch 'branch_office_id' from Get Remote Offices api

boundaryIDstringOptional

Unique identifier of the IP scope boundary.

ipScopeTypestringOptional

Type of IP scope definition. Allowed values: 'RANGE' (start-to-end IP address range) or 'SUBNET' (network address with subnet mask)

subnetClassstringOptional

Indicates the subnet class classification. Permitted values: A, B, or C. Required only when ipScopeType is 'SUBNET'

networkAddressstringOptional

The network address of the subnet (for example, 192.168.1.0). This field is required when ipScopeType is set to 'SUBNET'

subnetMaskstringOptional

Subnet mask for the network (e.g., '255.255.255.0'). Required only when ipScopeType is 'SUBNET'

startIPAddressstringOptional

Specifies the starting IP address of the range (for example, 192.168.1.1). Required only when ipScopeType is 'RANGE'

endIPAddressstringOptional

Specifies the ending IP address of the range (for example, 192.168.1.254). Required only when ipScopeType is 'RANGE'

descriptionstringOptional

Optional administrator-provided description for the IP scope (max 250 characters)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/dcapi/som/ip-scopes/{ip_scope_id} \
  --header 'Accept: application/ipScopeUpdatedStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/ipScopeDetail.v1+json' \
  --data '{}'

Sample Request Body

Update IP scope with range type

Copied!
  {
    "boundaryID": "301",
    "description": "HQ Network Range",
    "remoteOfficeID": "101",
    "ipScopeType": "RANGE",
    "startIPAddress": "192.168.1.1",
    "endIPAddress": "192.168.1.254"
  }
                
Show full

Update IP scope with subnet type

Copied!
  {
    "subnetClass": "C",
    "boundaryID": "302",
    "description": "Branch Office Subnet",
    "remoteOfficeID": "102",
    "ipScopeType": "SUBNET",
    "subnetMask": "255.255.255.0",
    "networkAddress": "10.0.1.0"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Indicates whether the IP scope operation (create, update, or delete) completed successfully

messagestring

Descriptive message providing details about the operation outcome or the reason for 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
404HTTP code
412HTTP code

Sample Response: HTTP 200

IP scope updated

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

Sample Response: HTTP 404

IP scope not found

Copied!
  {
    "errorCode": "30024",
    "message": "IP scope does not exist",
    "statusCode": 404
  }
                
Show full

Remote office not found for given remoteOfficeID

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

Sample Response: HTTP 412

Required IP scope parameters are missing

Copied!
  {
    "errorCode": "30022",
    "message": "Required IP scope parameters are missing",
    "statusCode": 412
  }
                
Show full

IP scope with same range already exists

Copied!
  {
    "errorCode": "30023",
    "message": "An IP scope with the same range already exists",
    "statusCode": 412
  }
                
Show full

Invalid IP range or subnet mask

Copied!
  {
    "errorCode": "30086",
    "message": "Invalid IP range or subnet mask parameters",
    "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.