Get Connection Configuration for RT Servers pull.application.config.get

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: pull

Who can execute the method: a user authorized in the application

The method pull.application.config.get returns the connection configuration for Push&Pull servers for the current application.

The method works only in the context of the application.

Method Parameters

Required parameters are marked with *

Name
type

Description

CACHE
string

Use cached data:

Y — use cache
N — do not use cache

If the parameter is not provided, the cache is used

REOPEN
string

Refresh channels upon expiration:

Y — refresh
N — do not refresh

If the parameter is not provided, refreshing is enabled

Code Examples

How to Use Examples in Documentation

Example of obtaining Push&Pull configuration for the application, where:

CACHE — cached data is used
REOPEN — refreshes channels

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "CACHE": "Y",
            "REOPEN": "Y",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/pull.application.config.get.json"

try
        {
        	const response = await $b24.callMethod(
        		'pull.application.config.get',
        		{
        			CACHE: 'Y',
        			REOPEN: 'Y'
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'pull.application.config.get',
                    [
                        'CACHE' => 'Y',
                        'REOPEN' => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting pull config: ' . $e->getMessage();
        }

BX24.callMethod(
            'pull.application.config.get',
            {
                CACHE: 'Y',
                REOPEN: 'Y'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );

$result = CRest::call(
            'pull.application.config.get',
            [
                'CACHE' => 'Y',
                'REOPEN' => 'Y',
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

Response Handling

HTTP Status: 200

{
            "result": {
                "server": {
                    "version": 4,
                    "server_enabled": true,
                    "mode": "personal",
                    "hostname": "your-account.bitrix24.com",
                    "long_polling": "https://rtc-**.bitrix24.com/sub2/",
                    "long_pooling_secure": "https://rtc-**.bitrix24.com/sub2/",
                    "websocket_enabled": true,
                    "websocket": "wss://rtc-**.bitrix24.com/subws2/",
                    "websocket_secure": "wss://rtc-**.bitrix24.com/subws2/",
                    "publish_enabled": true,
                    "publish": "https://rtc-**.bitrix24.com/rest/",
                    "publish_secure": "https://rtc-**.bitrix24.com/rest/",
                    "config_timestamp": 1774886062
                },
                "api": {
                    "revision_web": 19,
                    "revision_mobile": 3
                },
                "channels": {
                    "shared": {
                        "id": "***masked***",
                        "start": "2026-03-31T17:05:18+02:00",
                        "end": "2026-04-01T05:05:23+02:00",
                        "type": "shared"
                    },
                    "private": {
                        "id": "***masked***",
                        "public_id": "***masked***",
                        "start": "2026-03-31T17:05:18+02:00",
                        "end": "2026-04-01T05:05:23+02:00",
                        "type": "private"
                    }
                },
                "exp": 1775052318,
                "publicChannels": {
                    "<user_id>": {
                        "user_id": 577,
                        "public_id": "***masked***",
                        "signature": "***masked***",
                        "start": "2026-03-31T10:06:39+02:00",
                        "end": "2026-03-31T22:06:44+02:00"
                    }
                }
            },
            "time": {
                "start": 1774965918,
                "finish": 1774965918.322255,
                "duration": 0.32225489616394043,
                "processing": 0,
                "date_start": "2026-03-31T17:05:18+02:00",
                "date_finish": "2026-03-31T17:05:18+02:00",
                "operating_reset_at": 1774966518,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }

where:

field_n — field of the result object
value_n — value of the result field

See the fields of the result object in the Result Type section.

The composition of fields may vary and depends on the Push&Pull server configuration

time
time

Information about the request execution time

Result Type

Name `type`	Description
server `object`	Push&Pull server parameters more details
api `object`	Push&Pull API versions: revision_web `integer` — web API version revision_mobile `integer` — mobile API version
channels `object`	Application channels. Contains two channel types: `shared` and `private`. See the channel field descriptions in the Shared/Private Channel Type section
exp `integer`	Expiration time of the configuration in Unix timestamp format
publicChannels `object`	Public user channels in the format: `{ "<user_id>": { "user_id": user_id, "public_id": "string", "signature": "string", "start": "datetime", "end": "datetime" } }` where: `<user_id>` — user identifier `user_id` — user identifier `public_id` — public channel identifier `signature` — channel signature `start` — channel activation start time `end` — channel activation end time
clientId `string`	Public client identifier. Returned in shared mode of the server
jwt `string`	JWT token for connection. Returned if JWT issuance is enabled in the server configuration

Server Type

Name `type`	Description
version `integer`	Push&Pull server version
server_enabled `boolean`	Server availability indicator
mode `string`	Server mode
hostname `string`	Account hostname
long_polling `string`	Long polling URL
long_pooling_secure `string`	Long polling URL for secure connection
websocket_enabled `boolean`	WebSocket availability indicator
websocket `string`	WebSocket URL
websocket_secure `string`	WebSocket URL for secure connection
publish_enabled `boolean`	Publish API availability indicator
publish `string`	Publish API URL
publish_secure `string`	Publish API URL for secure connection
config_timestamp `integer`	Configuration version timestamp

Shared/Private Channel Type

Name `type`	Description
id `string`	Channel identifier
public_id `string` \| `null`	Public channel identifier. May be absent for `shared`
start `datetime`	Channel activation start time
end `datetime`	Channel activation end time
type `string`	Channel type: `shared` `private`

Error Handling

HTTP Status: 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Get access to application config available only for application authorization."
        }

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

Status	Code	Description	Value
`403`	`WRONG_AUTH_TYPE`	Get access to application config available only for application authorization.	Method call not from the context of an OAuth application

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

Push&Pull

Send events to the application's RT channel

Get Connection Configuration for RT Servers pull.application.config.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result TypeResult Type

Server TypeServer Type

Shared/Private Channel TypeShared/Private Channel Type

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning