Create a new 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

Creates a new IP scope for the customer. Supports range type (start-end IP) or subnet type (network address + mask).

Endpoints

Request URL

https://{server-hostname}:8383/dcapi/som/ip-scopes

Scope

SOM.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
remoteOfficeIDstringOptional

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

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 POST \
  --url https://appdomain/dcapi/som/ip-scopes \
  --header 'Accept: application/ipScopeAddedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/ipScopeDetail.v1+json' \
  --data '{"description":"HQ Network Range","remoteOfficeID":"101","ipScopeType":"RANGE","startIPAddress":"192.168.1.1","endIPAddress":"192.168.1.254"}'

Sample Request Body

Add IP scope with range type

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

Add IP scope with subnet type

Copied!
  {
    "subnetClass": "C",
    "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 403

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

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

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

Sample Response: HTTP 200

IP scope created

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

Sample Response: HTTP 403

Branch office not accessible by user

Copied!
  {
    "errorCode": "20011",
    "message": "Forbidden Access",
    "statusCode": 403
  }
                
Show full

Sample Response: HTTP 404

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.