VRt.Registry [RG] (7.36.3317)

Veeroute Support Team: support@veeroute.com License: Proprietary Terms of Service

Programming interface for Veeroute Registry.

Veeroute company website

Description

The service is designed to manage configuration files.

Entity diagram

erd

Explorer

Virtual filesystem management.

Create folder

Create new folder.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to create a folder. In the parent_key field, you must specify the key of the folder in which the new folder will be created. If parent_key is not specified, the folder is created in the root.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, `null` if the folder is root.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-04-21T19:45:00Z" Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

string <uuid> (unique_key)

New folder key.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-04-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Getting a filesystem

Getting a filesystem.

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Parent folder key, if not specified - a list of root folders is returned
filter	string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields - only those folders that contain a substring from the filter are returned: in folder name in folder comment
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (filesystem_column_type) Default: "NAME" Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 4 more Example: sort_field=CREATION_DATE The name of the column in the table with folders.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	object (folder) Folder is an element of a virtual file system.
required	Array of objects (folder) [ 0 .. 2001 ] items List of folders.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"folders": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"name": "My Folder",
"owner_company_key": "veeroute",
"owner_username": "username_1",
"comment": "long text",
"counters": {"folders_count": 0,
"files_count": 3
}
}
],
"counters": {"overall": {"total": 20
},
"filter": {"total": 1
}
}
}

Update folder

Rename and move folder.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/json
required

Folder update request.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, `null` if the folder is root.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-04-21T19:45:00Z" Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

required	object (folder) Folder is an element of a virtual file system.
required	Array of objects (folder) [ 0 .. 2001 ] items List of folders.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-04-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

{"folders": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"name": "My Folder",
"owner_company_key": "veeroute",
"owner_username": "username_1",
"comment": "long text",
"counters": {"folders_count": 0,
"files_count": 3
}
}
],
"counters": {"overall": {"total": 20
},
"filter": {"total": 1
}
}
}

Folder removal

Folder removal by key.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Folder specification

Getting a folder specification.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Parent folder key, `null` if the folder is root.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Folder name.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Folder comment.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Folder color.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2026-04-21T19:45:00Z" Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.
	Array of objects (attributes) [ 0 .. 250 ] items unique Attributes. Used to add service information.

Response samples

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2026-04-21T19:45:00Z",
"attributes": [ ]
}

Folder path

Folder path.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json

required

Array of objects (folder) [ 0 .. 1000 ] items

List of folders.

Response samples

Content type

application/json

{"folders": [{"key": "11111111-2222-3333-4444-555555555555",
"type": "FOLDER",
"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"attributes": [ ],
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"creation_date": "2026-04-21T19:45:00Z",
"expiration_date": "2026-04-21T19:45:00Z",
"counters": {"folders_count": 12,
"files_count": 16
}
}
]
}

Create folders (batch)

Create new folder (batch).

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to create a group of folders from the root of the virtual file system.

If any folder in the path already exists - it will not be created again.

The method returns the key of the last folder, even if no folders were created.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Last folder key.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Folders removal (batch)

Batch delete folders.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of folder keys that need to be deleted.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Folder key

Getting a folder key by path.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If any folder in the path not exists - 404 will be returned.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Last folder key.

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

File key

Getting a file key by path.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If in the folder multiple files with the same name - the last modified will be returned. If any folder or file in the path not exists - 404 will be returned.

folder_names required	Array of strings (folder_name_list) [ 0 .. 10 ] items [ items [ 1 .. 100 ] characters ] Example: ["folder_1"] List of folder names from the root of the virtual filesystem.
file_name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.

Responses

Response Schema: application/json

string <uuid> (unique_key)

File key.

Request samples

Payload

Content type

application/json

{"folder_names": [ ],
"file_name": "file_1"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Files removal (batch)

Batch delete files.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

List of file's keys that need to be deleted.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Filesystem counters

Getting a virtual filesystem counters.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

required	object (folder_counters) Current number of available folders/files.
required	object (folder_counters) Max number of available folders/files.

Response samples

Content type

application/json

{"current": {"folders_count": 12,
"files_count": 16
},
"max": {"folders_count": 12,
"files_count": 16
}
}

Backups

Bulk data export and import.

Folder export

Export folder with experiments.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/octet-stream

string <byte> (file_zip)

ZIP archive with data.

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Folder import

Import folder with experiments. The folder should not be of type ROOT and should be empty.

Authorizations:

ApiKeyAuth

path Parameters

target_folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/octet-stream
required

Data (ZIP).

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Configurations

File configuration management.

Create configuration

Create new configuration file.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

file create request.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" File comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" The key of the folder of type `FOLDER` in which the file is located.

Responses

Response Schema: application/json

string <uuid> (unique_key)

New configuration file key.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Reading configuration

Getting configuration file by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
content required	string (configuration_content) [ 0 .. 2000000 ] characters Example: "{\"long json\"}" Settings in JSON format.
json_schema required	string or null (configuration_json_schema) [ 0 .. 2000000 ] characters Example: "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}" Schema for validating content (settings) in JSON Schema format.
edit_date required	string <date-time> (file_edit_date) Example: "2026-04-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-04-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"content": "{}",
"json_schema": "{'$schema': 'https://json-schema.org/draft/2020-12/schema'}",
"edit_date": "2026-04-15T13:56:07.728Z",
"creation_date": "2026-04-15T13:56:07.728Z"
}

Specification update

Rename \ move configuration.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Configuration specification update request.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" File comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" The key of the folder of type `FOLDER` in which the file is located.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Key, unique identifier.
required	object (file_specification) File specification.
content required	string (configuration_content) [ 0 .. 2000000 ] characters Example: "{\"long json\"}" Settings in JSON format.
json_schema required	string or null (configuration_json_schema) [ 0 .. 2000000 ] characters Example: "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}" Schema for validating content (settings) in JSON Schema format.
edit_date required	string <date-time> (file_edit_date) Example: "2026-04-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2026-04-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"content": "{}",
"json_schema": "{'$schema': 'https://json-schema.org/draft/2020-12/schema'}",
"edit_date": "2026-04-15T13:56:07.728Z",
"creation_date": "2026-04-15T13:56:07.728Z"
}

Configuration removal

Configuration removal by key.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Schema read

Schema read.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json

string or null (configuration_json_schema) [ 0 .. 2000000 ] characters

Schema for validating content (settings) in JSON Schema format.

Response samples

Content type

application/json

"{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}"

Schema update

Schema update.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Configuration schema update request.

string or null (configuration_json_schema) [ 0 .. 2000000 ] characters

Schema for validating content (settings) in JSON Schema format.

Responses

Request samples

Payload

Content type

application/json

"{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}"

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Content read

Content read.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json

string (configuration_content) [ 0 .. 2000000 ] characters

Settings in JSON format.

Response samples

Content type

application/json

"{\"long json\"}"

Content update

Content update.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Configuration content update request.

string (configuration_content) [ 0 .. 2000000 ] characters

Settings in JSON format.

Responses

Request samples

Payload

Content type

application/json

"{\"long json\"}"

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2026-04-21T09:30:00+03:00"
},
"message": "bad data",
"schema_errors": [ ]
}

Configurations list (table)

Getting a table with configuration.

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Folder key, unique identifier.
filter	string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields - only those files are returned whose name or description contains a substring from the filter. If the filter is empty, all files in the folder are returned. The results are sorted by editing time.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_configuration_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Configuration table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	Array of objects (table_configuration) [ 0 .. 2001 ] items A list of configurations.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"essences": [{"essence_key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"edit_date": "2026-04-15T13:56:07.728Z",
"creation_date": "2026-04-15T13:56:07.728Z"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Configuration search

Configuration global search.

Authorizations:

ApiKeyAuth

query Parameters

filter required	string [ 3 .. 128 ] characters Example: filter=example text Filter for searching by text fields - only those configurations are returned whose name or description contains a substring from the filter. If the filter is empty, an empty list is returned. By default the results are sorted by editing time.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 The number of items to skip before starting to collect the result set.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 The number of items to return.
sort_field	string (table_configuration_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Configuration table column name.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	Array of objects (table_configuration) [ 0 .. 2001 ] items A list of configurations.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"essences": [{"essence_key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"edit_date": "2026-04-15T13:56:07.728Z",
"creation_date": "2026-04-15T13:56:07.728Z"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Configuration duplicate

Configuration duplicate.

Authorizations:

ApiKeyAuth

path Parameters

file_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Configuration duplicate request.

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" File name.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" File comment.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" The key of the folder of type `FOLDER` in which the file is located.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Duplicated configuration key.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

The current health indicator of the service.

0.0 means the service is not ready to perform tasks.
1.0 means the service is fully ready to perform tasks.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).
minor required	integer <int32> [ 0 .. 111 ] Example: "15" Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 15,
"build": "3754RC"
}

Getting the documentation

Getting the file with this service documentation.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html) [ 0 .. 2000000000 ] characters

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key_one",
"detail": null
}

VRt.Registry [RG] (7.36.3317)

Description

Entity diagram

Explorer

Create folder

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Getting a filesystem

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Update folder

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Folder removal

Authorizations:

path Parameters

Responses

Response samples

Folder specification

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Folder path

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Create folders (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Folders removal (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Folder key

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

File key

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Files removal (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Filesystem counters

Authorizations:

Responses

Response Schema: application/json

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/octet-stream
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required