Set Network Address Ranges timeman.networkrange.set

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: timeman

Who can execute the method: administrator

The method timeman.networkrange.set sets the network address ranges for the office network.

Method Parameters

Required parameters are marked with *

Name
type

Description

RANGES*
string

Network address ranges in the form of a list of objects. Each object contains a description of the network address range.

ranges: [
            {
                "ip_range": "10.0.0.0-10.255.255.255",
                "name": "Office Network 10.x.x.x"
            },
            {
                "ip_range": "10.10.0.1",
                "name": "Address 10.10.0.1"
            },
            ...
        ]

The range can contain:

a block of addresses, for example, 10.0.0.0-10.255.255.255
a single address, for example, 10.10.0.1

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ranges":[{"ip_range":"10.0.0.0-10.255.255.255","name":"Office Network 10.x.x.x"},{"ip_range":"172.16.0.0-172.31.255.255","name":"Office Network 172.x.x.x"},{"ip_range":"192.168.0.0-192.168.255.255","name":"Office Network 192.168.x.x"}]}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.networkrange.set

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ranges":[{"ip_range":"10.0.0.0-10.255.255.255","name":"Office Network 10.x.x.x"},{"ip_range":"172.16.0.0-172.31.255.255","name":"Office Network 172.x.x.x"},{"ip_range":"192.168.0.0-192.168.255.255","name":"Office Network 192.168.x.x"}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.networkrange.set

try
        {
        	const response = await $b24.callMethod(
        		'timeman.networkrange.set',
        		{
        			ranges: [
        				{
        					"ip_range": "10.0.0.0-10.255.255.255",
        					"name": "Office Network 10.x.x.x"
        				},
        				{
        					"ip_range": "172.16.0.0-172.31.255.255",
        					"name": "Office Network 172.x.x.x"
        				},
        				{
        					"ip_range": "192.168.0.0-192.168.255.255",
        					"name": "Office Network 192.168.x.x"
        				}
        			]
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error.ex);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.networkrange.set',
                    [
                        'ranges' => [
                            [
                                "ip_range" => "10.0.0.0-10.255.255.255",
                                "name"     => "Office Network 10.x.x.x"
                            ],
                            [
                                "ip_range" => "172.16.0.0-172.31.255.255",
                                "name"     => "Office Network 172.x.x.x"
                            ],
                            [
                                "ip_range" => "192.168.0.0-192.168.255.255",
                                "name"     => "Office Network 192.168.x.x"
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting network ranges: ' . $e->getMessage();
        }

BX24.callMethod(
            'timeman.networkrange.set',
            {
                ranges: [
                    {
                        "ip_range": "10.0.0.0-10.255.255.255",
                        "name": "Office Network 10.x.x.x"
                    },
                    {
                        "ip_range": "172.16.0.0-172.31.255.255",
                        "name": "Office Network 172.x.x.x"
                    },
                    {
                        "ip_range": "192.168.0.0-192.168.255.255",
                        "name": "Office Network 192.168.x.x"
                    }
                ]
            },
            function(result){
                if(result.error())
                {
                    console.error(result.error().ex);
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'timeman.networkrange.set',
            [
                'ranges' => [
                    [
                        'ip_range' => '10.0.0.0-10.255.255.255',
                        'name' => 'Office Network 10.x.x.x'
                    ],
                    [
                        'ip_range' => '172.16.0.0-172.31.255.255',
                        'name' => 'Office Network 172.x.x.x'
                    ],
                    [
                        'ip_range' => '192.168.0.0-192.168.255.255',
                        'name' => 'Office Network 192.168.x.x'
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "result": true
            },
            "time": {
                "start": 1742999863.0244141,
                "finish": 1742999863.057137,
                "duration": 0.03272294998168945,
                "processing": 0.0023658275604248047,
                "date_start": "2025-03-26T17:37:43+02:00",
                "date_finish": "2025-03-26T17:37:43+02:00",
                "operating_reset_at": 1743000463,
                "operating": 0
            }
        }

In case of range parsing error

HTTP Status: 200

{
            "result": {
                "result": false,
                "error_ranges": [
                    {
                        "ip_range": "a172.16.0.0-172.31.255.255",
                        "name": "Office Network 172.x.x.x"
                    }
                ]
            },
            "time": {
                "start": 1743058773.526674,
                "finish": 1743058773.5625639,
                "duration": 0.035889863967895508,
                "processing": 0.0005609989166259766,
                "date_start": "2025-03-27T09:59:33+02:00",
                "date_finish": "2025-03-27T09:59:33+02:00",
                "operating_reset_at": 1743059373,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response. Can have values: `true` — all ranges were successfully set `false` — there are ranges with errors
error_range `array`	Array of ranges where errors were found
time `time`	Information about the request execution time

Range Object

Name `type`	Description
ip_range `string`	Network address range
name `string`	Name of the range

Error Handling

HTTP Status: 400

{
            "error": "INVALID_FORMAT",
            "error_description": "A wrong format for the RANGES field is passed"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`ACCESS_ERROR`	You don't have access to use this method	The method is only available to the administrator
`INVALID_FORMAT`	A wrong format for the RANGES field is passed	An incorrect format was passed in the `RANGES` parameter

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get Network Address Range

Overview of Methods

Set Network Address Ranges timeman.networkrange.set

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

In case of range parsing errorIn case of range parsing error

Returned DataReturned Data

Range ObjectRange Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning