# Create a new IP scope

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

## Endpoint

`POST /dcapi/som/ip-scopes`

## Request

### Request URL

`https://`[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/dcapi/som/ip-scopes`

### Scope

`DesktopCentralCloud.SOM.CREATE`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Content-Type** `string` — **Mandatory**: `application/ipScopeDetail.v1+json`
- **Accept** `string` — **Mandatory**: `application/ipScopeAddedStatus.v1+json`

#### Request Body

`application/json`

JSON Object:

- **remoteOfficeID** `string` — Optional  
  Unique Identifier of the remote office this IP scope will assigned to. Fetch `resource_id` from [Get Remote Offices](https://www.manageengine.com/products/desktop-central/help/api/cloud/remote-offices-getremoteoffices.html) api.
- **ipScopeType** `string` — Optional  
  Type of IP scope definition. Allowed values: `RANGE` (start-to-end IP address range) or `SUBNET` (network address with subnet mask).
- **subnetClass** `string` — Optional  
  Indicates the subnet class classification. Permitted values: A, B, or C. Required only when `ipScopeType` is `SUBNET`.
- **networkAddress** `string` — Optional  
  The network address of the subnet (for example, `ip_address_1`). This field is required when `ipScopeType` is set to `SUBNET`.
- **subnetMask** `string` — Optional  
  Subnet mask for the network (e.g., `ip_address_2`). Required only when `ipScopeType` is `SUBNET`.
- **startIPAddress** `string` — Optional  
  Specifies the starting IP address of the range (for example, `ip_address_3`). Required only when `ipScopeType` is `RANGE`.
- **endIPAddress** `string` — Optional  
  Specifies the ending IP address of the range (for example, `ip_address_4`). Required only when `ipScopeType` is `RANGE`.
- **description** `string` — Optional  
  Optional administrator-provided description for the IP scope (max 250 characters).

### Sample Request

```curl
curl --request POST \
  --url https://appdomains/dcapi/som/ip-scopes \
  --header 'Accept: application/ipScopeAddedStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/ipScopeDetail.v1+json' \
  --data '{}'
```

### Sample Request Body

#### Add IP scope with range type

```json
{
  "description": "HQ Network Range",
  "remoteOfficeID": "101",
  "ipScopeType": "RANGE",
  "startIPAddress": "192.168.1.1",
  "endIPAddress": "192.168.1.254"
}
```

#### Add IP scope with subnet type

```json
{
  "subnetClass": "C",
  "description": "Branch Office Subnet",
  "remoteOfficeID": "102",
  "ipScopeType": "SUBNET",
  "subnetMask": "255.255.255.0",
  "networkAddress": "10.0.1.0"
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

JSON Object:

- **status** `boolean`  
  Indicates whether the IP scope operation (create, update, or delete) completed successfully.
- **message** `string`  
  Descriptive message providing details about the operation outcome or the reason for failure.

#### Sample Response: HTTP 200

IP scope created

```json
{
  "message": "success",
  "status": true
}
```

### HTTP Code 403

Response Body — `application/json`

JSON Object:

- **errorCode** `long`  
  Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin).
- **errorMsg** `string`  
  Message indicating insufficient privileges to access this resource.

#### Sample Response: HTTP 403

Branch office not accessible by user

```json
{
  "errorCode": "20011",
  "message": "Forbidden Access",
  "statusCode": 403
}
```

### HTTP Code 404

Response Body — `application/json`

JSON Object:

- **statusCode** `string`  
  HTTP status code (404).
- **errorCode** `string`  
  Error code identifying the resource that was not found.
- **message** `string`  
  Error message describing the missing resource.

#### Sample Response: HTTP 404

Remote office not found for given remoteOfficeID

```json
{
  "errorCode": "30028",
  "message": "Remote office not found",
  "statusCode": 404
}
```

### HTTP Code 412

Response Body — `application/json`

JSON Object:

- **statusCode** `string`  
  HTTP status code (412).
- **errorCode** `string`  
  Precondition failed error code identifying the business logic violation.
- **message** `string`  
  Error message describing the precondition failed while processing request.

#### Sample Response: HTTP 412

Required IP scope parameters are missing

```json
{
  "errorCode": "30022",
  "message": "Required IP scope parameters are missing",
  "statusCode": 412
}
```

IP scope with same range already exists

```json
{
  "errorCode": "30023",
  "message": "An IP scope with the same range already exists",
  "statusCode": 412
}
```

Invalid IP range or subnet mask

```json
{
  "errorCode": "30086",
  "message": "Invalid IP range or subnet mask parameters",
  "statusCode": 412
}
```

## Rate Limit

**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.