Документация Alarm Server

Материал из EWiki
Перейти к навигации Перейти к поиску

html документация для сервиса Alarm server

<svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
         m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
         -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
         0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
         -174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
         -174.68583 0.6895,0 26.281,25.03215 56.8701,
         55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
         -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
         -104.0616 -231.873,-231.248 z
       " fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
         m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
         -55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
         0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
         -174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
         -174.68583 0.6895,0 26.281,25.03215 56.8701,
         55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
         -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
         -104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg>

alarmserver (1.0.16)

Download OpenAPI specification:<a download="openapi.json" target="_blank" class="sc-kMkxaj iQWvAY">Download</a>

Alarm server

<a class="sc-jlZhew kbdRLs" href="#tag/service" aria-label="tag/service"></a>service

Access to node services

<a class="sc-jlZhew kbdRLs" href="#tag/service/operation/service.getServices" aria-label="tag/service/operation/service.getServices"></a>service.getServices

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/services<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/service/operation/service.initStructure" aria-label="tag/service/operation/service.initStructure"></a>init CMDB folder structure

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/services/initCMDBStructure<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/service/operation/service.dropCache" aria-label="tag/service/operation/service.dropCache"></a>reset cache info

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/services/cache/drop<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/service/operation/service.cacheValue" aria-label="tag/service/operation/service.cacheValue"></a>get cache value

query Parameters
<tbody></tbody>
id
required
string

object id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/services/cache/get<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/service/operation/service.cacheRemoveByTag" aria-label="tag/service/operation/service.cacheRemoveByTag"></a>remove cache by tag

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
tag
required
string

cache tag

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/services/cache/removeTag<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/service/operation/service.getCurrentStatus" aria-label="tag/service/operation/service.getCurrentStatus"></a>get current node status

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/services/nodeStatus<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/service/operation/service.stopServer" aria-label="tag/service/operation/service.stopServer"></a>stop alarm server

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
code
required
string

code

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/services/stop<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP" aria-label="tag/DHCP"></a>DHCP

Sniff DHCP Traffic

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.addZTPlist" aria-label="tag/DHCP/operation/DHCP.addZTPlist"></a>Method for working with ZTP list

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
obj
required
string <JSON>

Pattern of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/DHCP/addZTPlist<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.showZtpList" aria-label="tag/DHCP/operation/DHCP.showZtpList"></a>Get Table

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/DHCP/showZtpList<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.showOptPattern" aria-label="tag/DHCP/operation/DHCP.showOptPattern"></a>Method for working with options Pattern

query Parameters
<tbody></tbody>
template
string

template of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/DHCP/showOptPattern<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.changeOptPattern" aria-label="tag/DHCP/operation/DHCP.changeOptPattern"></a>Method for working options Pattern

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
obj
required
string <JSON>

changed template options

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">put/DHCP/changeOptPattern<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.getTable" aria-label="tag/DHCP/operation/DHCP.getTable"></a>Get Table

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/DHCP/getTable<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.changeJinjaPattern" aria-label="tag/DHCP/operation/DHCP.changeJinjaPattern"></a>Method for working Jinja Pattern

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
template
required
string

template of device

pattern
required
string

pattern of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">put/DHCP/changeJinjaPattern<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.startZTP" aria-label="tag/DHCP/operation/DHCP.startZTP"></a>Method for working with change flag

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
mac
required
string

Mac address of device

ip_address
required
string

ip address of device

gateway
required
string

gateway address of device

mask
required
string

mask of device

id
required
string

id of device

firmware
string

firmware of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">put/DHCP/startZTP<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.deleteRecord" aria-label="tag/DHCP/operation/DHCP.deleteRecord"></a>Method for working with table

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
mac
required
string

Delete record

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">delete/DHCP/deleteRecord<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.getPatternFileJinja2" aria-label="tag/DHCP/operation/DHCP.getPatternFileJinja2"></a>Method for send file

query Parameters
<tbody></tbody>
manufacturer
required
string

manufacturer of device

device_type
required
string

device type

vendor_code
required
string

vendor_code of device

filename
required
string

Name of file

Responses

<button class="sc-gdyeKB iyHUa-d" disabled="">204

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/DHCP/getPatternFileJinja2<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

<a class="sc-jlZhew kbdRLs" href="#tag/DHCP/operation/DHCP.findFiles" aria-label="tag/DHCP/operation/DHCP.findFiles"></a>Method for checking configs

query Parameters
<tbody></tbody>
manufacturer
required
string

manufacturer of device

device_type
required
string

device type

vendor_code
required
string

vendor_code of device

type
required
string

Type of file (image | jinja2)

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/DHCP/findFiles<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/auth" aria-label="tag/auth"></a>auth

auth model

<a class="sc-jlZhew kbdRLs" href="#tag/auth/operation/auth.login" aria-label="tag/auth/operation/auth.login"></a>auth.login

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
login
required
string

user name

password
required
string

password

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/auth/login<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/auth/operation/auth.loginByKerberos" aria-label="tag/auth/operation/auth.loginByKerberos"></a>auth.loginByKerberos

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/auth/login/kerberos<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/auth/operation/auth.logout" aria-label="tag/auth/operation/auth.logout"></a>auth.logout

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/auth/logout<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/auth/operation/auth.isLogged" aria-label="tag/auth/operation/auth.isLogged"></a>auth.isLogged

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/auth/logged<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/auth/operation/auth.getSessions" aria-label="tag/auth/operation/auth.getSessions"></a>auth.getSessions

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/auth/sessions<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/auth/operation/auth.dropSession" aria-label="tag/auth/operation/auth.dropSession"></a>auth.dropSession

path Parameters
<tbody></tbody>
id
required
string

session id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">delete/auth/session/{id}<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/burevestnik" aria-label="tag/burevestnik"></a>burevestnik

burevestnik bridge

<a class="sc-jlZhew kbdRLs" href="#tag/burevestnik/operation/burevestnik.getTopics" aria-label="tag/burevestnik/operation/burevestnik.getTopics"></a>query devices topics

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/burevestnik/topics<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_modbus" aria-label="tag/collector_modbus"></a>collector_modbus

Access to Modbus bridge

<a class="sc-jlZhew kbdRLs" href="#tag/collector_modbus/operation/collector_modbus.getCurrentState" aria-label="tag/collector_modbus/operation/collector_modbus.getCurrentState"></a>query current state of Modbus bridge

query Parameters
<tbody></tbody>
id
string

object id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/modbus/state<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_ping" aria-label="tag/collector_ping"></a>collector_ping

ping device

<a class="sc-jlZhew kbdRLs" href="#tag/collector_ping/operation/collector_ping.getPingObj" aria-label="tag/collector_ping/operation/collector_ping.getPingObj"></a>obj ping device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/collector_pings/getPingObj<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp" aria-label="tag/collector_snmp"></a>collector_snmp

Access to SNMP bridge

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp/operation/collector_snmp.getCurrentState" aria-label="tag/collector_snmp/operation/collector_snmp.getCurrentState"></a>query current state of SNMP bridge

query Parameters
<tbody></tbody>
id
string

object id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/collector_snmps/state<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp/operation/collector_snmp.getWorkerStatus" aria-label="tag/collector_snmp/operation/collector_snmp.getWorkerStatus"></a>query current workers state

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/collector_snmps/workers<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp/operation/collector_snmp.getRejectedOIDS" aria-label="tag/collector_snmp/operation/collector_snmp.getRejectedOIDS"></a>get alive and rejected OIDS

query Parameters
<tbody></tbody>
id
string

object id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/collector_snmps/rejected<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp/operation/collector_snmp.getTableOID" aria-label="tag/collector_snmp/operation/collector_snmp.getTableOID"></a>get limit OID table

query Parameters
<tbody></tbody>
id
required
string

object id

oid
required
string

object oid

colums
string

columns

maxRepetitions
number <double>

count repetitions

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/collector_snmps/getTable<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp/operation/collector_snmp.queryStateTableData" aria-label="tag/collector_snmp/operation/collector_snmp.queryStateTableData"></a>query state table for device

query Parameters
<tbody></tbody>
id
required
string

object id

stateTable
required
string

state table name

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/collector_snmps/getStateTable<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp/operation/collector_snmp.getOID" aria-label="tag/collector_snmp/operation/collector_snmp.getOID"></a>get value OID

query Parameters
<tbody></tbody>
id
required
string

object id

oid
required
string

object oid

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/collector_snmps/getOID<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_snmp/operation/collector_snmp.queryStateOID" aria-label="tag/collector_snmp/operation/collector_snmp.queryStateOID"></a>query state table for device

query Parameters
<tbody></tbody>
id
required
string

object id

stateTable
required
string

state table name

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/collector_snmps/queryStateOID<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory" aria-label="tag/unem_inventory"></a>unem_inventory

UNEM inventory

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory/operation/unem_inventory.getDevices" aria-label="tag/unem_inventory/operation/unem_inventory.getDevices"></a>query all registered umux devices

query Parameters
<tbody></tbody>
configId
required
string

config object id

sourceType
string

telnet | postgres

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/unem_inventory/devices<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory/operation/unem_inventory.getModulesInventory" aria-label="tag/unem_inventory/operation/unem_inventory.getModulesInventory"></a>query device inventory

query Parameters
<tbody></tbody>
configId
required
string

config object id

deviceId
required
string

device IP address

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/unem_inventory/inventory/modules<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory/operation/unem_inventory.getPortsInventory" aria-label="tag/unem_inventory/operation/unem_inventory.getPortsInventory"></a>query device inventory

query Parameters
<tbody></tbody>
configId
required
string

config object id

deviceId
required
string

device IP address

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/unem_inventory/inventory/ports<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory/operation/unem_inventory.getCrossConnectionInventory" aria-label="tag/unem_inventory/operation/unem_inventory.getCrossConnectionInventory"></a>query cross connection inventory

query Parameters
<tbody></tbody>
configId
required
string

config object id

deviceId
required
string

device $id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/unem_inventory/inventory/crossconnection<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory/operation/unem_inventory.getInventory" aria-label="tag/unem_inventory/operation/unem_inventory.getInventory"></a>query device inventory

query Parameters
<tbody></tbody>
configId
required
string

config object id

deviceId
required
string

device IP address

deviceNeId
required
string

device IP address

sourceType
required
string

telnet | postgres

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/unem_inventory/inventory<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory/operation/unem_inventory.publishInventory" aria-label="tag/unem_inventory/operation/unem_inventory.publishInventory"></a>query device inventory

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
configId
required
string

config object id

deviceId
required
string

device IP address

deviceNeId
required
string

device IP address

sourceType
required
string

telnet | postgres

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/unem_inventory/publish<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/unem_inventory/operation/unem_inventory.getConfig" aria-label="tag/unem_inventory/operation/unem_inventory.getConfig"></a>get current config

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/unem_inventory/config<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_wmi" aria-label="tag/collector_wmi"></a>collector_wmi

Access to WMI bridge

<a class="sc-jlZhew kbdRLs" href="#tag/collector_wmi/operation/collector_wmi.getCurrentState" aria-label="tag/collector_wmi/operation/collector_wmi.getCurrentState"></a>query current state of wmi bridge

query Parameters
<tbody></tbody>
id
string

device id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/wmi/state<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_wmi/operation/collector_wmi.execWql" aria-label="tag/collector_wmi/operation/collector_wmi.execWql"></a>execute WQL query

query Parameters
<tbody></tbody>
wmi_class
required
string

wmi class

wmi_property
required
string

wmi property

wmi_filter
string

wql where expression

id
string

device $id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/wmi/wql<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/collector_wmi/operation/collector_wmi.doInventory" aria-label="tag/collector_wmi/operation/collector_wmi.doInventory"></a>Looks for device modules

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
item_name
required
string

host device(module) name

item_class
required
string

host device(module) class

item_template
required
string

host device(module) template

wmi_host
required
string

wmi host

wmi_login
required
string

wmi user

wmi_password
required
string

wmi password

wmi_domain
string

wmi user domain

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/wmi/inventory<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/data_book" aria-label="tag/data_book"></a>data_book

get data list for store in long data storage

<a class="sc-jlZhew kbdRLs" href="#tag/data_book/operation/data_book.getAllObjects" aria-label="tag/data_book/operation/data_book.getAllObjects"></a>get all objects info

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/data_book<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/data_book/operation/data_book.getObject" aria-label="tag/data_book/operation/data_book.getObject"></a>get object info

path Parameters
<tbody></tbody>
id
required
string

object id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/data_book/{id}<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/data_book/operation/data_book.startPolling" aria-label="tag/data_book/operation/data_book.startPolling"></a>add or renew device to control

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
string

objectId

collectorName
string

collector reinit (device id will be ignored)

dontRegisterMeasures
boolean

non for web call !

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/data_book/polling<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/data_book/operation/data_book.litePolling" aria-label="tag/data_book/operation/data_book.litePolling"></a>repolling only roles (not objects)

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
string

objectId

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/data_book/polling/lite<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/data_book/operation/data_book.testBridge" aria-label="tag/data_book/operation/data_book.testBridge"></a>run bridge test

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

object id

bridge
required
string

bridge id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/data_book/test/run<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/data_book/operation/data_book.testBridgeProgress" aria-label="tag/data_book/operation/data_book.testBridgeProgress"></a>get bridge test progress

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/data_book/test/progress<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/data_book/operation/data_book.syncCMDBObjects" aria-label="tag/data_book/operation/data_book.syncCMDBObjects"></a>get bridge test progress

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/data_book/cmdb/sync<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/node_server" aria-label="tag/node_server"></a>node_server

node_server

<a class="sc-jlZhew kbdRLs" href="#tag/node_server/operation/node_server.getCurrentStatus" aria-label="tag/node_server/operation/node_server.getCurrentStatus"></a>query current bridge status

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/node_server/status<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/calculator" aria-label="tag/calculator"></a>calculator

Access to calculator bridge

<a class="sc-jlZhew kbdRLs" href="#tag/calculator/operation/calculator.testCalc" aria-label="tag/calculator/operation/calculator.testCalc"></a>test object calc bridge

query Parameters
<tbody></tbody>
nodeId
required
string

device (node) id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/calculator/test<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/dj" aria-label="tag/dj"></a>dj

duty journal functions

<a class="sc-jlZhew kbdRLs" href="#tag/dj/operation/dj.getRecords" aria-label="tag/dj/operation/dj.getRecords"></a>query all duty journal records

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/dj/records<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/dj/operation/dj.getSyncList" aria-label="tag/dj/operation/dj.getSyncList"></a>get sync => dj list

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/dj/syncList<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/historian" aria-label="tag/historian"></a>historian

API for configure switch

<a class="sc-jlZhew kbdRLs" href="#tag/historian/operation/historian.getMeasures" aria-label="tag/historian/operation/historian.getMeasures"></a>query measures data (from time database) by time step

query Parameters
<tbody></tbody>
measures
string <JSON>

measures list

fromRt
required
string <date-time>

from record time (ISO format)

toRt
required
string <date-time>

to record time (ISO format)

timeStep
required
number <double>

time step in seconds

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/historian/measures<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/license" aria-label="tag/license"></a>license

Access to license API

<a class="sc-jlZhew kbdRLs" href="#tag/license/operation/license.getDeviceId" aria-label="tag/license/operation/license.getDeviceId"></a>get device id for license query

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/license/deviceid<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/logs_enode" aria-label="tag/logs_enode"></a>logs_enode

get data list for store in long data storage

<a class="sc-jlZhew kbdRLs" href="#tag/logs_enode/operation/logs_enode.getLog" aria-label="tag/logs_enode/operation/logs_enode.getLog"></a>query logs

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
table
string

table

filter
string <JSON>

filter request

count
number <double>

records count

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/logs_enode<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/logs_enode/operation/logs_enode.getLogCount" aria-label="tag/logs_enode/operation/logs_enode.getLogCount"></a>query logs

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
table
string

table clickhouse

filter
string <JSON>

filter request

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/logs_enode/count<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/logs_enode/operation/logs_enode.getTagValues" aria-label="tag/logs_enode/operation/logs_enode.getTagValues"></a>query tag values

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
table
string

table clickhouse

filter
string <JSON>

filter request

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/logs_enode/tag<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror" aria-label="tag/mirror"></a>mirror

Access to mirror (current data)

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getCurrentStates" aria-label="tag/mirror/operation/mirror.getCurrentStates"></a>get nodes state info

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/states<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getMirrorIDList" aria-label="tag/mirror/operation/mirror.getMirrorIDList"></a>get mirror objects

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getMirror" aria-label="tag/mirror/operation/mirror.getMirror"></a>get full mirror info

query Parameters
<tbody></tbody>
id
string <JSON>

idList

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/all<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getMirrorById" aria-label="tag/mirror/operation/mirror.getMirrorById"></a>get full mirror info

path Parameters
<tbody></tbody>
id
required
string

objectId

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/{id}<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getStatesByPrefix" aria-label="tag/mirror/operation/mirror.getStatesByPrefix"></a>get states by prefix (for ex: inventory)

query Parameters
<tbody></tbody>
prefix
required
string

prefix

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/statesByPrefix<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getMeasure" aria-label="tag/mirror/operation/mirror.getMeasure"></a>get single measure by cmdb id like measure$1

path Parameters
<tbody></tbody>
id
required
string <JSON>

measure id list [1,2,3,4]

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/measure/{id}<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getMeasures" aria-label="tag/mirror/operation/mirror.getMeasures"></a>get measures

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/measures<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getRowMirror" aria-label="tag/mirror/operation/mirror.getRowMirror"></a>get measures

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/row<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getMeasuresMaps" aria-label="tag/mirror/operation/mirror.getMeasuresMaps"></a>get measures maps

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/maps<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getStateCounters" aria-label="tag/mirror/operation/mirror.getStateCounters"></a>get states counters

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/state/counters<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getDeviceMirror" aria-label="tag/mirror/operation/mirror.getDeviceMirror"></a>get device measures

path Parameters
<tbody></tbody>
id
required
string

device id

query Parameters
<tbody></tbody>
withMirror
boolean

add mirror data

withSubObjects
boolean

add subobjects

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/mirror/device/{id}/measures<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.forceSetState" aria-label="tag/mirror/operation/mirror.forceSetState"></a>update state rom client

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

device id

state
required
string

new device state

message
string

message

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/mirror/state<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.getStats" aria-label="tag/mirror/operation/mirror.getStats"></a>get measure(s) stats

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
string

measure id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/mirror/measure/stats<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.testCalc" aria-label="tag/mirror/operation/mirror.testCalc"></a>measure test calc

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

measure id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/mirror/measure/testcalc<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/mirror/operation/mirror.dropExtStates" aria-label="tag/mirror/operation/mirror.dropExtStates"></a>drop extStates for object

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

measure id

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/mirror/dropextstates<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/node_actions" aria-label="tag/node_actions"></a>node_actions

dynamic config creator

<a class="sc-jlZhew kbdRLs" href="#tag/node_actions/operation/node_actions.getSubinterfaces" aria-label="tag/node_actions/operation/node_actions.getSubinterfaces"></a>generate config

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
nodeId
required
string

nodeId

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/node_actions/getSubinterfaces<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref" aria-label="tag/state_ref"></a>state_ref

передача состояний родительским элементам от устройства (на folder, cabinet)

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref/operation/state_ref.getCurrentState" aria-label="tag/state_ref/operation/state_ref.getCurrentState"></a>query current bridge state

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/state_ref/state<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref_2" aria-label="tag/state_ref_2"></a>state_ref_2

state ref analyser v2 (передача стейтов для каналов)

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref_2/operation/state_ref_2.getCurrentConfig" aria-label="tag/state_ref_2/operation/state_ref_2.getCurrentConfig"></a>query current bridge config

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/state_ref_2/config<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref_4" aria-label="tag/state_ref_4"></a>state_ref_4

передача состояний от port|module|slot до уровня device (всем промежуточным узлам)

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref_4/operation/state_ref_4.getCurrentConfig" aria-label="tag/state_ref_4/operation/state_ref_4.getCurrentConfig"></a>query current bridge config

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/state_ref_4/config<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref5" aria-label="tag/state_ref5"></a>state_ref5

state ref for externs links to another objects with states

<a class="sc-jlZhew kbdRLs" href="#tag/state_ref5/operation/state_ref5.getMaps" aria-label="tag/state_ref5/operation/state_ref5.getMaps"></a>get object maps

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/state_ref5/maps<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/state_unknown" aria-label="tag/state_unknown"></a>state_unknown

state_unknown

<a class="sc-jlZhew kbdRLs" href="#tag/state_unknown/operation/state_unknown.getCurrentConfig" aria-label="tag/state_unknown/operation/state_unknown.getCurrentConfig"></a>query current bridge config

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/state_unknown/config<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/static_fields" aria-label="tag/static_fields"></a>static_fields

dynamic to static fields mapper

<a class="sc-jlZhew kbdRLs" href="#tag/static_fields/operation/static_fields.getState" aria-label="tag/static_fields/operation/static_fields.getState"></a>query bridge state

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/static_fields/state<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings" aria-label="tag/switch_settings"></a>switch_settings

API for configure switch

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.searchFunctions" aria-label="tag/switch_settings/operation/switch_settings.searchFunctions"></a>Search functions for all types of switch

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/searchFunctions<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.searchFunctionsForPrefix" aria-label="tag/switch_settings/operation/switch_settings.searchFunctionsForPrefix"></a>Search functions for one type of switch

query Parameters
<tbody></tbody>
prefix
required
string

Prefix for template

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/searchFunctionsForPrefix<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.searchTemplates" aria-label="tag/switch_settings/operation/switch_settings.searchTemplates"></a>Search models of switches

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/searchTemplates<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.searchMethods" aria-label="tag/switch_settings/operation/switch_settings.searchMethods"></a>Search functions for one model of switch

query Parameters
<tbody></tbody>
name
required
string

Name of model

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/searchMethods<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.execCommand" aria-label="tag/switch_settings/operation/switch_settings.execCommand"></a>Executing the transmitted command for the switch

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

name
required
string

Name of method

accepts
string <JSON>

Parameters accepted by the function

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/switch_settings/swset/execCommand<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.deviceConfig" aria-label="tag/switch_settings/operation/switch_settings.deviceConfig"></a>Work with conf

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

method
required
string

Type of method

conf
string

Type of conf

commit
string

Commit hash for get method

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/switch_settings/swset/deviceConfig<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.getConfigById" aria-label="tag/switch_settings/operation/switch_settings.getConfigById"></a>get conf by id

query Parameters
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of config (runningconfig)

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/getConfigById<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.getCommitsById" aria-label="tag/switch_settings/operation/switch_settings.getCommitsById"></a>get conf by id

query Parameters
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of config (runningconfig)

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/getCommitsById<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.getConfigByCommit" aria-label="tag/switch_settings/operation/switch_settings.getConfigByCommit"></a>get conf by id

query Parameters
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of config (runningconfig)

commit
required
string

hash of commit

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/getConfigByCommit<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.getDiffsByCommits" aria-label="tag/switch_settings/operation/switch_settings.getDiffsByCommits"></a>get conf by id

query Parameters
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of config (runningconfig)

tocommit
required
string

hash of last commit

fromcommit
required
string

hash of previous commit

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/getDiffsByCommits<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.sendConfigToDolt" aria-label="tag/switch_settings/operation/switch_settings.sendConfigToDolt"></a>Send config to dolt

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

configtype
required
string

Type of config

config
string

Config for send

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/switch_settings/swset/sendConfigToDolt<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.checkSyncDoltForDevice" aria-label="tag/switch_settings/operation/switch_settings.checkSyncDoltForDevice"></a>A method for checking the synchronization of the device config with config from dolt

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

configtype
required
string

Type of config

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/switch_settings/swset/checkSyncDoltForDevice<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.checkSyncStartAndRunningForDevice" aria-label="tag/switch_settings/operation/switch_settings.checkSyncStartAndRunningForDevice"></a>A method for checking the synchronization of the start config and running config in dolt

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/switch_settings/swset/checkSyncStartAndRunningForDevice<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.checkSyncAllConfigsForDevice" aria-label="tag/switch_settings/operation/switch_settings.checkSyncAllConfigsForDevice"></a>A method for checking the synchronization of all configs for device

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/switch_settings/swset/checkSyncAllConfigsForDevice<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.getCountOfConfigs" aria-label="tag/switch_settings/operation/switch_settings.getCountOfConfigs"></a>get count of configs by id

query Parameters
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of config (runningconfig)

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/getCountOfConfigs<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.deviceFiles" aria-label="tag/switch_settings/operation/switch_settings.deviceFiles"></a>Method for working with configs

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of file (image | jinja2)

filename
required
string

Name of config

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/switch_settings/swset/deviceFiles<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.findFiles" aria-label="tag/switch_settings/operation/switch_settings.findFiles"></a>Method for checking configs

query Parameters
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of file (image | jinja2)

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/findFiles<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.putImage" aria-label="tag/switch_settings/operation/switch_settings.putImage"></a>Method for send image file

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">put/switch_settings/swset/putImage<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.putJinja" aria-label="tag/switch_settings/operation/switch_settings.putJinja"></a>Method for send jinja file

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">put/switch_settings/swset/putJinja<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.putConfig" aria-label="tag/switch_settings/operation/switch_settings.putConfig"></a>Method for send config file

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of device

configtype
required
string

Type of config

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">put/switch_settings/swset/putConfig<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.getConfigFile" aria-label="tag/switch_settings/operation/switch_settings.getConfigFile"></a>Method for send file

query Parameters
<tbody></tbody>
id
required
string

Id of device

configtype
required
string

Type of config

commit
required
string

hash of commit

Responses

<button class="sc-gdyeKB iyHUa-d" disabled="">204

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/getConfigFile<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

<a class="sc-jlZhew kbdRLs" href="#tag/switch_settings/operation/switch_settings.getStaticFile" aria-label="tag/switch_settings/operation/switch_settings.getStaticFile"></a>Method for send file

query Parameters
<tbody></tbody>
id
required
string

Id of device

type
required
string

Type of file (image | jinja2)

filename
required
string

Name of file

Responses

<button class="sc-gdyeKB iyHUa-d" disabled="">204

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/switch_settings/swset/getStaticFile<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager" aria-label="tag/task_manager"></a>task_manager

API for tasking

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.showTask" aria-label="tag/task_manager/operation/task_manager.showTask"></a>Shows task

query Parameters
<tbody></tbody>
id
required
string

Id of task

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/task_manager/showTask<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.showAllTasks" aria-label="tag/task_manager/operation/task_manager.showAllTasks"></a>Shows all tasks

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/task_manager/showAllTasks<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.showTaskWithFilter" aria-label="tag/task_manager/operation/task_manager.showTaskWithFilter"></a>Shows task with filter

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
filter
required
string <JSON>

Filter items : { "name", "user", "alternativename", "startRT", "status", "endRT" }

count
required
number <double>

Count of records

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/task_manager/showTaskWithFilter<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.showTimeTask" aria-label="tag/task_manager/operation/task_manager.showTimeTask"></a>Shows time task

query Parameters
<tbody></tbody>
id
required
string

Id of task

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/task_manager/showTimeTask<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.showAllTimeTasks" aria-label="tag/task_manager/operation/task_manager.showAllTimeTasks"></a>Shows all time tasks

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/task_manager/showAllTimeTasks<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.showTimeTaskWithFilter" aria-label="tag/task_manager/operation/task_manager.showTimeTaskWithFilter"></a>Shows time tasks with filter

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
filter
required
string <JSON>

Filter items : { "name", "running", "createdby", "updatedby", "createdAT", "updatedAT", "lastdoneAT", "croninterval" }

count
required
number <double>

Count of records

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/task_manager/showTimeTaskWithFilter<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.updateTimeTask" aria-label="tag/task_manager/operation/task_manager.updateTimeTask"></a>Update time for time task

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of time task

newtime
required
string

Time with Cron syntax

data
string <JSON>

New data for time task

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/task_manager/swset/updateTimeTask<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.stopTimeTask" aria-label="tag/task_manager/operation/task_manager.stopTimeTask"></a>Stop time task

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of time task

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/task_manager/swset/stopTimeTask<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/task_manager/operation/task_manager.startTimeTask" aria-label="tag/task_manager/operation/task_manager.startTimeTask"></a>Start time task

Request Body schema: application/x-www-form-urlencoded
<tbody></tbody>
id
required
string

Id of time task

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">post/task_manager/swset/startTimeTask<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/ftp_server" aria-label="tag/ftp_server"></a>ftp_server

FTP

<a class="sc-jlZhew kbdRLs" href="#tag/ftp_server/operation/ftp_server.getURL" aria-label="tag/ftp_server/operation/ftp_server.getURL"></a>Give url

query Parameters
<tbody></tbody>
id
required
string

Id of device

get|put
required
string

Type of method

dirrectory
required
string

Directory or table

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/ftp_server/getURL<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }

<a class="sc-jlZhew kbdRLs" href="#tag/ftp_server/operation/ftp_server.test" aria-label="tag/ftp_server/operation/ftp_server.test"></a>test

Responses

<button class="sc-gdyeKB bzckyT"><svg class="sc-cwHptR hWEnWx" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg>200

Request was successful

</button>
<button class="sc-eZYNyq jtLmPa">get/ftp_server/test<svg class="sc-cwHptR iVFMLx" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button>

Response samples

Content type
<svg class="sc-dtInlm eUMxuS" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option selected="" value="application/json">application/json</option><option value="application/xml">application/xml</option><option value="text/xml">text/xml</option><option value="application/javascript">application/javascript</option><option value="text/javascript">text/javascript</option></select><label>application/json</label>
<button>
Copy
</button>
{ }
   <script>
   const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"1.0.16","title":"alarmserver","description":"Alarm server"},"paths":{"/services":{"get":{"tags":["service"],"operationId":"service.getServices","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/services/initCMDBStructure":{"post":{"tags":["service"],"summary":"init CMDB folder structure","operationId":"service.initStructure","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/services/cache/drop":{"post":{"tags":["service"],"summary":"reset cache info","operationId":"service.dropCache","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/services/cache/get":{"get":{"tags":["service"],"summary":"get cache value","operationId":"service.cacheValue","parameters":[{"name":"id","in":"query","description":"object id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/services/cache/removeTag":{"post":{"tags":["service"],"summary":"remove cache by tag","operationId":"service.cacheRemoveByTag","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"tag":{"description":"cache tag","type":"string"}},"required":["tag"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/services/nodeStatus":{"get":{"tags":["service"],"summary":"get current node status","operationId":"service.getCurrentStatus","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/services/stop":{"post":{"tags":["service"],"summary":"stop alarm server","operationId":"service.stopServer","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"code":{"description":"code","type":"string"}},"required":["code"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/addZTPlist":{"post":{"tags":["DHCP"],"summary":"Method for working with ZTP list","operationId":"DHCP.addZTPlist","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"obj":{"description":"Pattern of device","type":"string","format":"JSON"}},"required":["obj"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/showZtpList":{"get":{"tags":["DHCP"],"summary":"Get Table","operationId":"DHCP.showZtpList","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/showOptPattern":{"get":{"tags":["DHCP"],"summary":"Method for working with options Pattern","operationId":"DHCP.showOptPattern","parameters":[{"name":"template","in":"query","description":"template of device","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/changeOptPattern":{"put":{"tags":["DHCP"],"summary":"Method for working options Pattern","operationId":"DHCP.changeOptPattern","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"obj":{"description":"changed template options","type":"string","format":"JSON"}},"required":["obj"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/getTable":{"get":{"tags":["DHCP"],"summary":"Get Table","operationId":"DHCP.getTable","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/changeJinjaPattern":{"put":{"tags":["DHCP"],"summary":"Method for working Jinja Pattern","operationId":"DHCP.changeJinjaPattern","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"template":{"description":"template of device","type":"string"},"pattern":{"description":"pattern of device","type":"string"}},"required":["template","pattern"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/startZTP":{"put":{"tags":["DHCP"],"summary":"Method for working with change flag","operationId":"DHCP.startZTP","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"mac":{"description":"Mac address of device","type":"string"},"ip_address":{"description":"ip address of device","type":"string"},"gateway":{"description":"gateway address of device","type":"string"},"mask":{"description":"mask of device","type":"string"},"id":{"description":"id of device","type":"string"},"firmware":{"description":"firmware of device","type":"string"}},"required":["mac","ip_address","gateway","mask","id"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/deleteRecord":{"delete":{"tags":["DHCP"],"summary":"Method for working with table","operationId":"DHCP.deleteRecord","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"mac":{"description":"Delete record","type":"string"}},"required":["mac"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/DHCP/getPatternFileJinja2":{"get":{"tags":["DHCP"],"summary":"Method for send file","operationId":"DHCP.getPatternFileJinja2","parameters":[{"name":"manufacturer","in":"query","description":"manufacturer of device","required":true,"schema":{"type":"string"}},{"name":"device_type","in":"query","description":"device type","required":true,"schema":{"type":"string"}},{"name":"vendor_code","in":"query","description":"vendor_code of device","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"Name of file","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Request was successful"}},"deprecated":false}},"/DHCP/findFiles":{"get":{"tags":["DHCP"],"summary":"Method for checking configs","operationId":"DHCP.findFiles","parameters":[{"name":"manufacturer","in":"query","description":"manufacturer of device","required":true,"schema":{"type":"string"}},{"name":"device_type","in":"query","description":"device type","required":true,"schema":{"type":"string"}},{"name":"vendor_code","in":"query","description":"vendor_code of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of file (image | jinja2)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/auth/login":{"post":{"tags":["auth"],"operationId":"auth.login","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"login":{"description":"user name","type":"string"},"password":{"description":"password","type":"string"}},"required":["login","password"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/auth/login/kerberos":{"post":{"tags":["auth"],"operationId":"auth.loginByKerberos","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/auth/logout":{"post":{"tags":["auth"],"operationId":"auth.logout","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/auth/logged":{"get":{"tags":["auth"],"operationId":"auth.isLogged","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/auth/sessions":{"get":{"tags":["auth"],"operationId":"auth.getSessions","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/auth/session/{id}":{"delete":{"tags":["auth"],"operationId":"auth.dropSession","parameters":[{"name":"id","in":"path","description":"session id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/burevestnik/topics":{"get":{"tags":["burevestnik"],"summary":"query devices topics","operationId":"burevestnik.getTopics","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/modbus/state":{"get":{"tags":["collector_modbus"],"summary":"query current state of Modbus bridge","operationId":"collector_modbus.getCurrentState","parameters":[{"name":"id","in":"query","description":"object id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_pings/getPingObj":{"get":{"tags":["collector_ping"],"summary":"obj ping device","operationId":"collector_ping.getPingObj","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_snmps/state":{"get":{"tags":["collector_snmp"],"summary":"query current state of SNMP bridge","operationId":"collector_snmp.getCurrentState","parameters":[{"name":"id","in":"query","description":"object id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_snmps/workers":{"post":{"tags":["collector_snmp"],"summary":"query current workers state","operationId":"collector_snmp.getWorkerStatus","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_snmps/rejected":{"get":{"tags":["collector_snmp"],"summary":"get alive and rejected OIDS","operationId":"collector_snmp.getRejectedOIDS","parameters":[{"name":"id","in":"query","description":"object id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_snmps/getTable":{"get":{"tags":["collector_snmp"],"summary":"get limit OID table","operationId":"collector_snmp.getTableOID","parameters":[{"name":"id","in":"query","description":"object id","required":true,"schema":{"type":"string"}},{"name":"oid","in":"query","description":"object oid","required":true,"schema":{"type":"string"}},{"name":"colums","in":"query","description":"columns","required":false,"schema":{"type":"string"}},{"name":"maxRepetitions","in":"query","description":"count repetitions","required":false,"schema":{"type":"number","format":"double"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_snmps/getStateTable":{"get":{"tags":["collector_snmp"],"summary":"query state table for device","operationId":"collector_snmp.queryStateTableData","parameters":[{"name":"id","in":"query","description":"object id","required":true,"schema":{"type":"string"}},{"name":"stateTable","in":"query","description":"state table name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_snmps/getOID":{"get":{"tags":["collector_snmp"],"summary":"get value OID","operationId":"collector_snmp.getOID","parameters":[{"name":"id","in":"query","description":"object id","required":true,"schema":{"type":"string"}},{"name":"oid","in":"query","description":"object oid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/collector_snmps/queryStateOID":{"get":{"tags":["collector_snmp"],"summary":"query state table for device","operationId":"collector_snmp.queryStateOID","parameters":[{"name":"id","in":"query","description":"object id","required":true,"schema":{"type":"string"}},{"name":"stateTable","in":"query","description":"state table name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/unem_inventory/devices":{"get":{"tags":["unem_inventory"],"summary":"query all registered umux devices","operationId":"unem_inventory.getDevices","parameters":[{"name":"configId","in":"query","description":"config object id","required":true,"schema":{"type":"string"}},{"name":"sourceType","in":"query","description":"telnet | postgres","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/unem_inventory/inventory/modules":{"get":{"tags":["unem_inventory"],"summary":"query device inventory","operationId":"unem_inventory.getModulesInventory","parameters":[{"name":"configId","in":"query","description":"config object id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"device IP address","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/unem_inventory/inventory/ports":{"get":{"tags":["unem_inventory"],"summary":"query device inventory","operationId":"unem_inventory.getPortsInventory","parameters":[{"name":"configId","in":"query","description":"config object id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"device IP address","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/unem_inventory/inventory/crossconnection":{"get":{"tags":["unem_inventory"],"summary":"query cross connection inventory","operationId":"unem_inventory.getCrossConnectionInventory","parameters":[{"name":"configId","in":"query","description":"config object id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"device $id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/unem_inventory/inventory":{"get":{"tags":["unem_inventory"],"summary":"query device inventory","operationId":"unem_inventory.getInventory","parameters":[{"name":"configId","in":"query","description":"config object id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"query","description":"device IP address","required":true,"schema":{"type":"string"}},{"name":"deviceNeId","in":"query","description":"device IP address","required":true,"schema":{"type":"string"}},{"name":"sourceType","in":"query","description":"telnet | postgres","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/unem_inventory/publish":{"post":{"tags":["unem_inventory"],"summary":"query device inventory","operationId":"unem_inventory.publishInventory","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"configId":{"description":"config object id","type":"string"},"deviceId":{"description":"device IP address","type":"string"},"deviceNeId":{"description":"device IP address","type":"string"},"sourceType":{"description":"telnet | postgres","type":"string"}},"required":["configId","deviceId","deviceNeId","sourceType"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/unem_inventory/config":{"post":{"tags":["unem_inventory"],"summary":"get current config","operationId":"unem_inventory.getConfig","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/wmi/state":{"get":{"tags":["collector_wmi"],"summary":"query current state of wmi bridge","operationId":"collector_wmi.getCurrentState","parameters":[{"name":"id","in":"query","description":"device id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/wmi/wql":{"get":{"tags":["collector_wmi"],"summary":"execute WQL query","operationId":"collector_wmi.execWql","parameters":[{"name":"wmi_class","in":"query","description":"wmi class","required":true,"schema":{"type":"string"}},{"name":"wmi_property","in":"query","description":"wmi property","required":true,"schema":{"type":"string"}},{"name":"wmi_filter","in":"query","description":"wql where expression","required":false,"schema":{"type":"string"}},{"name":"id","in":"query","description":"device $id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/wmi/inventory":{"post":{"tags":["collector_wmi"],"summary":"Looks for device modules","operationId":"collector_wmi.doInventory","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"item_name":{"description":"host device(module) name","type":"string"},"item_class":{"description":"host device(module) class","type":"string"},"item_template":{"description":"host device(module) template","type":"string"},"wmi_host":{"description":"wmi host","type":"string"},"wmi_login":{"description":"wmi user","type":"string"},"wmi_password":{"description":"wmi password","type":"string"},"wmi_domain":{"description":"wmi user domain","type":"string"}},"required":["item_name","item_class","item_template","wmi_host","wmi_login","wmi_password"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/data_book":{"get":{"tags":["data_book"],"summary":"get all objects info","operationId":"data_book.getAllObjects","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/data_book/{id}":{"get":{"tags":["data_book"],"summary":"get object info","operationId":"data_book.getObject","parameters":[{"name":"id","in":"path","description":"object id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/data_book/polling":{"post":{"tags":["data_book"],"summary":"add or renew device to control","operationId":"data_book.startPolling","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"objectId","type":"string"},"collectorName":{"description":"collector reinit (device id will be ignored)","type":"string"},"dontRegisterMeasures":{"description":"non for web call !","type":"boolean"}}}}}},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/data_book/polling/lite":{"post":{"tags":["data_book"],"summary":"repolling only roles (not objects)","operationId":"data_book.litePolling","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"objectId","type":"string"}}}}}},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/data_book/test/run":{"post":{"tags":["data_book"],"summary":"run bridge test","operationId":"data_book.testBridge","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"object id","type":"string"},"bridge":{"description":"bridge id","type":"string"}},"required":["id","bridge"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/data_book/test/progress":{"post":{"tags":["data_book"],"summary":"get bridge test progress","operationId":"data_book.testBridgeProgress","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/data_book/cmdb/sync":{"post":{"tags":["data_book"],"summary":"get bridge test progress","operationId":"data_book.syncCMDBObjects","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/node_server/status":{"get":{"tags":["node_server"],"summary":"query current bridge status","operationId":"node_server.getCurrentStatus","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/calculator/test":{"get":{"tags":["calculator"],"summary":"test object calc bridge","operationId":"calculator.testCalc","parameters":[{"name":"nodeId","in":"query","description":"device (node) id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/dj/records":{"post":{"tags":["dj"],"summary":"query all duty journal records","operationId":"dj.getRecords","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/dj/syncList":{"get":{"tags":["dj"],"summary":"get sync => dj list","operationId":"dj.getSyncList","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/historian/measures":{"get":{"tags":["historian"],"summary":"query measures data (from time database) by time step","operationId":"historian.getMeasures","parameters":[{"name":"measures","in":"query","description":"measures list","required":false,"schema":{"type":"string","format":"JSON"}},{"name":"fromRt","in":"query","description":"from record time (ISO format)","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"toRt","in":"query","description":"to record time (ISO format)","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"timeStep","in":"query","description":"time step in seconds","required":true,"schema":{"type":"number","format":"double"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/license/deviceid":{"get":{"tags":["license"],"summary":"get device id for license query","operationId":"license.getDeviceId","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/logs_enode":{"post":{"tags":["logs_enode"],"summary":"query logs","operationId":"logs_enode.getLog","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"table":{"description":"table","type":"string"},"filter":{"description":"filter request","type":"string","format":"JSON"},"count":{"description":"records count","type":"number","format":"double"}}}}}},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/logs_enode/count":{"post":{"tags":["logs_enode"],"summary":"query logs","operationId":"logs_enode.getLogCount","requestBody":{"$ref":"#/components/requestBodies/logs_enode.getLogCount"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/logs_enode/tag":{"post":{"tags":["logs_enode"],"summary":"query tag values","operationId":"logs_enode.getTagValues","requestBody":{"$ref":"#/components/requestBodies/logs_enode.getLogCount"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/states":{"get":{"tags":["mirror"],"summary":"get nodes state info","operationId":"mirror.getCurrentStates","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror":{"get":{"tags":["mirror"],"summary":"get mirror objects","operationId":"mirror.getMirrorIDList","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/all":{"get":{"tags":["mirror"],"summary":"get full mirror info","operationId":"mirror.getMirror","parameters":[{"name":"id","in":"query","description":"idList","required":false,"schema":{"type":"string","format":"JSON"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/{id}":{"get":{"tags":["mirror"],"summary":"get full mirror info","operationId":"mirror.getMirrorById","parameters":[{"name":"id","in":"path","description":"objectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/statesByPrefix":{"get":{"tags":["mirror"],"summary":"get states by prefix (for ex: inventory)","operationId":"mirror.getStatesByPrefix","parameters":[{"name":"prefix","in":"query","description":"prefix","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/measure/{id}":{"get":{"tags":["mirror"],"summary":"get single measure by cmdb id like measure$1","operationId":"mirror.getMeasure","parameters":[{"name":"id","in":"path","description":"measure id list [1,2,3,4]","required":true,"schema":{"type":"string","format":"JSON"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/measures":{"get":{"tags":["mirror"],"summary":"get measures","operationId":"mirror.getMeasures","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/row":{"get":{"tags":["mirror"],"summary":"get measures","operationId":"mirror.getRowMirror","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/maps":{"get":{"tags":["mirror"],"summary":"get measures maps","operationId":"mirror.getMeasuresMaps","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/state/counters":{"get":{"tags":["mirror"],"summary":"get states counters","operationId":"mirror.getStateCounters","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/device/{id}/measures":{"get":{"tags":["mirror"],"summary":"get device measures","operationId":"mirror.getDeviceMirror","parameters":[{"name":"id","in":"path","description":"device id","required":true,"schema":{"type":"string"}},{"name":"withMirror","in":"query","description":"add mirror data","required":false,"schema":{"type":"boolean"}},{"name":"withSubObjects","in":"query","description":"add subobjects","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/state":{"post":{"tags":["mirror"],"summary":"update state rom client","operationId":"mirror.forceSetState","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"device id","type":"string"},"state":{"description":"new device state","type":"string"},"message":{"description":"message","type":"string"}},"required":["id","state"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/measure/stats":{"post":{"tags":["mirror"],"summary":"get measure(s) stats","operationId":"mirror.getStats","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"measure id","type":"string"}}}}}},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/measure/testcalc":{"post":{"tags":["mirror"],"summary":"measure test calc","operationId":"mirror.testCalc","requestBody":{"$ref":"#/components/requestBodies/mirror.testCalc"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/mirror/dropextstates":{"post":{"tags":["mirror"],"summary":"drop extStates for object","operationId":"mirror.dropExtStates","requestBody":{"$ref":"#/components/requestBodies/mirror.testCalc"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/node_actions/getSubinterfaces":{"post":{"tags":["node_actions"],"summary":"generate config","operationId":"node_actions.getSubinterfaces","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"nodeId":{"description":"nodeId","type":"string"}},"required":["nodeId"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/state_ref/state":{"get":{"tags":["state_ref"],"summary":"query current bridge state","operationId":"state_ref.getCurrentState","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/state_ref_2/config":{"get":{"tags":["state_ref_2"],"summary":"query current bridge config","operationId":"state_ref_2.getCurrentConfig","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/state_ref_4/config":{"get":{"tags":["state_ref_4"],"summary":"query current bridge config","operationId":"state_ref_4.getCurrentConfig","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/state_ref5/maps":{"get":{"tags":["state_ref5"],"summary":"get object maps","operationId":"state_ref5.getMaps","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/state_unknown/config":{"get":{"tags":["state_unknown"],"summary":"query current bridge config","operationId":"state_unknown.getCurrentConfig","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/static_fields/state":{"get":{"tags":["static_fields"],"summary":"query bridge state","operationId":"static_fields.getState","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/searchFunctions":{"get":{"tags":["switch_settings"],"summary":"Search functions for all types of switch","operationId":"switch_settings.searchFunctions","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/searchFunctionsForPrefix":{"get":{"tags":["switch_settings"],"summary":"Search functions for one type of switch","operationId":"switch_settings.searchFunctionsForPrefix","parameters":[{"name":"prefix","in":"query","description":"Prefix for template","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/searchTemplates":{"get":{"tags":["switch_settings"],"summary":"Search models of switches","operationId":"switch_settings.searchTemplates","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/searchMethods":{"get":{"tags":["switch_settings"],"summary":"Search functions for one model of switch","operationId":"switch_settings.searchMethods","parameters":[{"name":"name","in":"query","description":"Name of model","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/execCommand":{"post":{"tags":["switch_settings"],"summary":"Executing the transmitted command for the switch","operationId":"switch_settings.execCommand","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of device","type":"string"},"name":{"description":"Name of method","type":"string"},"accepts":{"description":"Parameters accepted by the function","type":"string","format":"JSON"}},"required":["id","name"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/deviceConfig":{"post":{"tags":["switch_settings"],"summary":"Work with conf","operationId":"switch_settings.deviceConfig","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of device","type":"string"},"method":{"description":"Type of method","type":"string"},"conf":{"description":"Type of conf","type":"string"},"commit":{"description":"Commit hash for get method","type":"string"}},"required":["id","method"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/getConfigById":{"get":{"tags":["switch_settings"],"summary":"get conf by id","operationId":"switch_settings.getConfigById","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of config (runningconfig)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/getCommitsById":{"get":{"tags":["switch_settings"],"summary":"get conf by id","operationId":"switch_settings.getCommitsById","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of config (runningconfig)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/getConfigByCommit":{"get":{"tags":["switch_settings"],"summary":"get conf by id","operationId":"switch_settings.getConfigByCommit","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of config (runningconfig)","required":true,"schema":{"type":"string"}},{"name":"commit","in":"query","description":"hash of commit","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/getDiffsByCommits":{"get":{"tags":["switch_settings"],"summary":"get conf by id","operationId":"switch_settings.getDiffsByCommits","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of config (runningconfig)","required":true,"schema":{"type":"string"}},{"name":"tocommit","in":"query","description":"hash of last commit","required":true,"schema":{"type":"string"}},{"name":"fromcommit","in":"query","description":"hash of previous commit","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/sendConfigToDolt":{"post":{"tags":["switch_settings"],"summary":"Send config to dolt","operationId":"switch_settings.sendConfigToDolt","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of device","type":"string"},"configtype":{"description":"Type of config","type":"string"},"config":{"description":"Config for send","type":"string"}},"required":["id","configtype"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/checkSyncDoltForDevice":{"post":{"tags":["switch_settings"],"summary":"A method for checking the synchronization of the device config with config from dolt","operationId":"switch_settings.checkSyncDoltForDevice","requestBody":{"$ref":"#/components/requestBodies/switch_settings.checkSyncDoltForDevice"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/checkSyncStartAndRunningForDevice":{"post":{"tags":["switch_settings"],"summary":"A method for checking the synchronization of the start config and running config in dolt","operationId":"switch_settings.checkSyncStartAndRunningForDevice","requestBody":{"$ref":"#/components/requestBodies/switch_settings.checkSyncStartAndRunningForDevice"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/checkSyncAllConfigsForDevice":{"post":{"tags":["switch_settings"],"summary":"A method for checking the synchronization of all configs for device","operationId":"switch_settings.checkSyncAllConfigsForDevice","requestBody":{"$ref":"#/components/requestBodies/switch_settings.checkSyncStartAndRunningForDevice"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/getCountOfConfigs":{"get":{"tags":["switch_settings"],"summary":"get count of configs by id","operationId":"switch_settings.getCountOfConfigs","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of config (runningconfig)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/deviceFiles":{"post":{"tags":["switch_settings"],"summary":"Method for working with configs","operationId":"switch_settings.deviceFiles","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of device","type":"string"},"type":{"description":"Type of file (image | jinja2)","type":"string"},"filename":{"description":"Name of config","type":"string"}},"required":["id","type","filename"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/findFiles":{"get":{"tags":["switch_settings"],"summary":"Method for checking configs","operationId":"switch_settings.findFiles","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of file (image | jinja2)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/putImage":{"put":{"tags":["switch_settings"],"summary":"Method for send image file","operationId":"switch_settings.putImage","requestBody":{"$ref":"#/components/requestBodies/switch_settings.checkSyncStartAndRunningForDevice"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/putJinja":{"put":{"tags":["switch_settings"],"summary":"Method for send jinja file","operationId":"switch_settings.putJinja","requestBody":{"$ref":"#/components/requestBodies/switch_settings.checkSyncStartAndRunningForDevice"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/putConfig":{"put":{"tags":["switch_settings"],"summary":"Method for send config file","operationId":"switch_settings.putConfig","requestBody":{"$ref":"#/components/requestBodies/switch_settings.checkSyncDoltForDevice"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/switch_settings/swset/getConfigFile":{"get":{"tags":["switch_settings"],"summary":"Method for send file","operationId":"switch_settings.getConfigFile","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"configtype","in":"query","description":"Type of config","required":true,"schema":{"type":"string"}},{"name":"commit","in":"query","description":"hash of commit","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Request was successful"}},"deprecated":false}},"/switch_settings/swset/getStaticFile":{"get":{"tags":["switch_settings"],"summary":"Method for send file","operationId":"switch_settings.getStaticFile","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type of file (image | jinja2)","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"Name of file","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Request was successful"}},"deprecated":false}},"/task_manager/showTask":{"get":{"tags":["task_manager"],"summary":"Shows task","operationId":"task_manager.showTask","parameters":[{"name":"id","in":"query","description":"Id of task","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/showAllTasks":{"get":{"tags":["task_manager"],"summary":"Shows all tasks","operationId":"task_manager.showAllTasks","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/showTaskWithFilter":{"post":{"tags":["task_manager"],"summary":"Shows task with filter","operationId":"task_manager.showTaskWithFilter","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"filter":{"description":"Filter items : { \"name\", \"user\", \"alternativename\", \"startRT\", \"status\", \"endRT\" }","type":"string","format":"JSON"},"count":{"description":"Count of records","type":"number","format":"double"}},"required":["filter","count"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/showTimeTask":{"get":{"tags":["task_manager"],"summary":"Shows time task","operationId":"task_manager.showTimeTask","parameters":[{"name":"id","in":"query","description":"Id of task","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/showAllTimeTasks":{"get":{"tags":["task_manager"],"summary":"Shows all time tasks","operationId":"task_manager.showAllTimeTasks","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/showTimeTaskWithFilter":{"post":{"tags":["task_manager"],"summary":"Shows time tasks with filter","operationId":"task_manager.showTimeTaskWithFilter","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"filter":{"description":"Filter items : { \"name\", \"running\", \"createdby\", \"updatedby\", \"createdAT\", \"updatedAT\", \"lastdoneAT\", \"croninterval\" }","type":"string","format":"JSON"},"count":{"description":"Count of records","type":"number","format":"double"}},"required":["filter","count"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/swset/updateTimeTask":{"post":{"tags":["task_manager"],"summary":"Update time for time task","operationId":"task_manager.updateTimeTask","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of time task","type":"string"},"newtime":{"description":"Time with Cron syntax","type":"string"},"data":{"description":"New data for time task","type":"string","format":"JSON"}},"required":["id","newtime"]}}},"required":true},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/swset/stopTimeTask":{"post":{"tags":["task_manager"],"summary":"Stop time task","operationId":"task_manager.stopTimeTask","requestBody":{"$ref":"#/components/requestBodies/task_manager.stopTimeTask"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/task_manager/swset/startTimeTask":{"post":{"tags":["task_manager"],"summary":"Start time task","operationId":"task_manager.startTimeTask","requestBody":{"$ref":"#/components/requestBodies/task_manager.stopTimeTask"},"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/ftp_server/getURL":{"get":{"tags":["ftp_server"],"summary":"Give url","operationId":"ftp_server.getURL","parameters":[{"name":"id","in":"query","description":"Id of device","required":true,"schema":{"type":"string"}},{"name":"get|put","in":"query","description":"Type of method","required":true,"schema":{"type":"string"}},{"name":"dirrectory","in":"query","description":"Directory or table","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}},"/ftp_server/test":{"get":{"tags":["ftp_server"],"summary":"test","operationId":"ftp_server.test","responses":{"200":{"description":"Request was successful","content":{"application/json":{"schema":{"type":"object"}},"application/xml":{"schema":{"type":"object"}},"text/xml":{"schema":{"type":"object"}},"application/javascript":{"schema":{"type":"object"}},"text/javascript":{"schema":{"type":"object"}}}}},"deprecated":false}}},"tags":[{"name":"service","description":"Access to node services"},{"name":"DHCP","description":"Sniff DHCP Traffic"},{"name":"auth","description":"auth model"},{"name":"burevestnik","description":"burevestnik bridge"},{"name":"collector_modbus","description":"Access to Modbus bridge"},{"name":"collector_ping","description":"ping device"},{"name":"collector_snmp","description":"Access to SNMP bridge"},{"name":"unem_inventory","description":"UNEM inventory"},{"name":"collector_wmi","description":"Access to WMI bridge"},{"name":"data_book","description":"get data list for store in long data storage"},{"name":"node_server","description":"node_server"},{"name":"calculator","description":"Access to calculator bridge"},{"name":"dj","description":"duty journal functions"},{"name":"historian","description":"API for configure switch"},{"name":"license","description":"Access to license API"},{"name":"logs_enode","description":"get data list for store in long data storage"},{"name":"mirror","description":"Access to mirror (current data)"},{"name":"node_actions","description":"dynamic config creator"},{"name":"state_ref","description":"передача состояний родительским элементам от устройства (на folder, cabinet)"},{"name":"state_ref_2","description":"state ref analyser v2 (передача стейтов для каналов)"},{"name":"state_ref_4","description":"передача состояний от port|module|slot до уровня device (всем промежуточным узлам)"},{"name":"state_ref5","description":"state ref for externs links to another objects with states"},{"name":"state_unknown","description":"state_unknown"},{"name":"static_fields","description":"dynamic to static fields mapper"},{"name":"switch_settings","description":"API for configure switch"},{"name":"task_manager","description":"API for tasking"},{"name":"ftp_server","description":"FTP"}],"servers":[{"url":"/alarm"}],"components":{"requestBodies":{"switch_settings.checkSyncStartAndRunningForDevice":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of device","type":"string"}},"required":["id"]}}},"required":true},"switch_settings.checkSyncDoltForDevice":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of device","type":"string"},"configtype":{"description":"Type of config","type":"string"}},"required":["id","configtype"]}}},"required":true},"logs_enode.getLogCount":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"table":{"description":"table clickhouse","type":"string"},"filter":{"description":"filter request","type":"string","format":"JSON"}}}}}},"task_manager.stopTimeTask":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"Id of time task","type":"string"}},"required":["id"]}}},"required":true},"mirror.testCalc":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"description":"measure id","type":"string"}},"required":["id"]}}},"required":true}},"schemas":{"x-any":{"properties":{}}}}}},"searchIndex":{"store":["tag/service","tag/service/operation/service.getServices","tag/service/operation/service.initStructure","tag/service/operation/service.dropCache","tag/service/operation/service.cacheValue","tag/service/operation/service.cacheRemoveByTag","tag/service/operation/service.getCurrentStatus","tag/service/operation/service.stopServer","tag/DHCP","tag/DHCP/operation/DHCP.addZTPlist","tag/DHCP/operation/DHCP.showZtpList","tag/DHCP/operation/DHCP.showOptPattern","tag/DHCP/operation/DHCP.changeOptPattern","tag/DHCP/operation/DHCP.getTable","tag/DHCP/operation/DHCP.changeJinjaPattern","tag/DHCP/operation/DHCP.startZTP","tag/DHCP/operation/DHCP.deleteRecord","tag/DHCP/operation/DHCP.getPatternFileJinja2","tag/DHCP/operation/DHCP.findFiles","tag/auth","tag/auth/operation/auth.login","tag/auth/operation/auth.loginByKerberos","tag/auth/operation/auth.logout","tag/auth/operation/auth.isLogged","tag/auth/operation/auth.getSessions","tag/auth/operation/auth.dropSession","tag/burevestnik","tag/burevestnik/operation/burevestnik.getTopics","tag/collector_modbus","tag/collector_modbus/operation/collector_modbus.getCurrentState","tag/collector_ping","tag/collector_ping/operation/collector_ping.getPingObj","tag/collector_snmp","tag/collector_snmp/operation/collector_snmp.getCurrentState","tag/collector_snmp/operation/collector_snmp.getWorkerStatus","tag/collector_snmp/operation/collector_snmp.getRejectedOIDS","tag/collector_snmp/operation/collector_snmp.getTableOID","tag/collector_snmp/operation/collector_snmp.queryStateTableData","tag/collector_snmp/operation/collector_snmp.getOID","tag/collector_snmp/operation/collector_snmp.queryStateOID","tag/unem_inventory","tag/unem_inventory/operation/unem_inventory.getDevices","tag/unem_inventory/operation/unem_inventory.getModulesInventory","tag/unem_inventory/operation/unem_inventory.getPortsInventory","tag/unem_inventory/operation/unem_inventory.getCrossConnectionInventory","tag/unem_inventory/operation/unem_inventory.getInventory","tag/unem_inventory/operation/unem_inventory.publishInventory","tag/unem_inventory/operation/unem_inventory.getConfig","tag/collector_wmi","tag/collector_wmi/operation/collector_wmi.getCurrentState","tag/collector_wmi/operation/collector_wmi.execWql","tag/collector_wmi/operation/collector_wmi.doInventory","tag/data_book","tag/data_book/operation/data_book.getAllObjects","tag/data_book/operation/data_book.getObject","tag/data_book/operation/data_book.startPolling","tag/data_book/operation/data_book.litePolling","tag/data_book/operation/data_book.testBridge","tag/data_book/operation/data_book.testBridgeProgress","tag/data_book/operation/data_book.syncCMDBObjects","tag/node_server","tag/node_server/operation/node_server.getCurrentStatus","tag/calculator","tag/calculator/operation/calculator.testCalc","tag/dj","tag/dj/operation/dj.getRecords","tag/dj/operation/dj.getSyncList","tag/historian","tag/historian/operation/historian.getMeasures","tag/license","tag/license/operation/license.getDeviceId","tag/logs_enode","tag/logs_enode/operation/logs_enode.getLog","tag/logs_enode/operation/logs_enode.getLogCount","tag/logs_enode/operation/logs_enode.getTagValues","tag/mirror","tag/mirror/operation/mirror.getCurrentStates","tag/mirror/operation/mirror.getMirrorIDList","tag/mirror/operation/mirror.getMirror","tag/mirror/operation/mirror.getMirrorById","tag/mirror/operation/mirror.getStatesByPrefix","tag/mirror/operation/mirror.getMeasure","tag/mirror/operation/mirror.getMeasures","tag/mirror/operation/mirror.getRowMirror","tag/mirror/operation/mirror.getMeasuresMaps","tag/mirror/operation/mirror.getStateCounters","tag/mirror/operation/mirror.getDeviceMirror","tag/mirror/operation/mirror.forceSetState","tag/mirror/operation/mirror.getStats","tag/mirror/operation/mirror.testCalc","tag/mirror/operation/mirror.dropExtStates","tag/node_actions","tag/node_actions/operation/node_actions.getSubinterfaces","tag/state_ref","tag/state_ref/operation/state_ref.getCurrentState","tag/state_ref_2","tag/state_ref_2/operation/state_ref_2.getCurrentConfig","tag/state_ref_4","tag/state_ref_4/operation/state_ref_4.getCurrentConfig","tag/state_ref5","tag/state_ref5/operation/state_ref5.getMaps","tag/state_unknown","tag/state_unknown/operation/state_unknown.getCurrentConfig","tag/static_fields","tag/static_fields/operation/static_fields.getState","tag/switch_settings","tag/switch_settings/operation/switch_settings.searchFunctions","tag/switch_settings/operation/switch_settings.searchFunctionsForPrefix","tag/switch_settings/operation/switch_settings.searchTemplates","tag/switch_settings/operation/switch_settings.searchMethods","tag/switch_settings/operation/switch_settings.execCommand","tag/switch_settings/operation/switch_settings.deviceConfig","tag/switch_settings/operation/switch_settings.getConfigById","tag/switch_settings/operation/switch_settings.getCommitsById","tag/switch_settings/operation/switch_settings.getConfigByCommit","tag/switch_settings/operation/switch_settings.getDiffsByCommits","tag/switch_settings/operation/switch_settings.sendConfigToDolt","tag/switch_settings/operation/switch_settings.checkSyncDoltForDevice","tag/switch_settings/operation/switch_settings.checkSyncStartAndRunningForDevice","tag/switch_settings/operation/switch_settings.checkSyncAllConfigsForDevice","tag/switch_settings/operation/switch_settings.getCountOfConfigs","tag/switch_settings/operation/switch_settings.deviceFiles","tag/switch_settings/operation/switch_settings.findFiles","tag/switch_settings/operation/switch_settings.putImage","tag/switch_settings/operation/switch_settings.putJinja","tag/switch_settings/operation/switch_settings.putConfig","tag/switch_settings/operation/switch_settings.getConfigFile","tag/switch_settings/operation/switch_settings.getStaticFile","tag/task_manager","tag/task_manager/operation/task_manager.showTask","tag/task_manager/operation/task_manager.showAllTasks","tag/task_manager/operation/task_manager.showTaskWithFilter","tag/task_manager/operation/task_manager.showTimeTask","tag/task_manager/operation/task_manager.showAllTimeTasks","tag/task_manager/operation/task_manager.showTimeTaskWithFilter","tag/task_manager/operation/task_manager.updateTimeTask","tag/task_manager/operation/task_manager.stopTimeTask","tag/task_manager/operation/task_manager.startTimeTask","tag/ftp_server","tag/ftp_server/operation/ftp_server.getURL","tag/ftp_server/operation/ftp_server.test"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.986]],["description/0",[0,2.646,1,2.101,2,2.646]],["title/1",[3,6.127]],["description/1",[0,4.304]],["title/2",[4,3.798,5,3.372,6,3.372,7,3.798]],["description/2",[8,5.288]],["title/3",[9,4.349,10,3.539,11,2.948]],["description/3",[12,5.288]],["title/4",[10,4.14,13,4.14]],["description/4",[14,5.288]],["title/5",[10,3.539,15,4.349,16,3.861]],["description/5",[17,5.288]],["title/6",[2,3.539,18,2.323,19,3.861]],["description/6",[20,5.288]],["title/7",[21,3.861,22,4.349,23,4.349]],["description/7",[24,5.288]],["title/8",[25,5.439]],["description/8",[25,2.886,26,3.251,27,3.251]],["title/9",[28,1.701,29,2.35,30,3.798,31,2.881]],["description/9",[32,5.288]],["title/10",[33,4.152]],["description/10",[34,5.288]],["title/11",[28,1.701,29,2.35,35,3.372,36,3.091]],["description/11",[37,5.288]],["title/12",[28,1.701,29,2.35,35,3.372,36,3.091]],["description/12",[38,5.288]],["title/13",[33,4.152]],["description/13",[39,5.288]],["title/14",[28,1.701,29,2.35,36,3.091,40,3.372]],["description/14",[41,5.288]],["title/15",[28,1.701,29,2.35,42,3.798,43,3.798]],["description/15",[44,5.288]],["title/16",[28,1.948,29,2.691,33,2.948]],["description/16",[45,5.288]],["title/17",[28,1.948,46,2.811,47,2.948]],["description/17",[48,5.288]],["title/18",[28,1.948,49,3.107,50,2.117]],["description/18",[51,5.288]],["title/19",[52,5.439]],["description/19",[52,3.575,53,3.277]],["title/20",[54,6.127]],["description/20",[55,5.288]],["title/21",[56,6.127]],["description/21",[57,5.288]],["title/22",[58,6.127]],["description/22",[59,5.288]],["title/23",[60,6.127]],["description/23",[61,5.288]],["title/24",[62,6.127]],["description/24",[63,5.288]],["title/25",[64,6.127]],["description/25",[65,5.288]],["title/26",[66,5.439]],["description/26",[66,3.575,67,1.804]],["title/27",[68,1.604,69,2.001,70,4.349]],["description/27",[71,5.288]],["title/28",[72,6.127]],["description/28",[1,2.101,67,1.456,73,2.886]],["title/29",[18,1.8,67,1.51,68,1.244,73,2.993,74,1.69]],["description/29",[75,5.288]],["title/30",[76,6.127]],["description/30",[69,1.853,77,3.575]],["title/31",[69,2.001,77,3.861,78,4.349]],["description/31",[79,5.288]],["title/32",[80,6.127]],["description/32",[1,2.101,67,1.456,81,2.886]],["title/33",[18,1.8,67,1.51,68,1.244,74,1.69,81,2.993]],["description/33",[82,5.288]],["title/34",[18,2.028,68,1.401,74,1.904,83,3.798]],["description/34",[84,5.288]],["title/35",[85,4.349,86,4.349,87,3.539]],["description/35",[88,5.288]],["title/36",[33,2.948,87,3.539,89,4.349]],["description/36",[90,5.288]],["title/37",[33,2.574,68,1.401,69,1.747,74,1.904]],["description/37",[91,5.288]],["title/38",[13,4.14,87,4.14]],["description/38",[92,5.288]],["title/39",[33,2.574,68,1.401,69,1.747,74,1.904]],["description/39",[93,5.288]],["title/40",[94,6.127]],["description/40",[95,4.027,96,2.603]],["title/41",[68,1.401,69,1.747,97,3.798,98,3.798]],["description/41",[99,5.288]],["title/42",[68,1.604,69,2.001,96,2.811]],["description/42",[100,5.288]],["title/43",[68,1.604,69,2.001,96,2.811]],["description/43",[101,5.288]],["title/44",[68,1.401,96,2.455,102,3.798,103,3.798]],["description/44",[104,5.288]],["title/45",[68,1.604,69,2.001,96,2.811]],["description/45",[105,5.288]],["title/46",[68,1.604,69,2.001,96,2.811]],["description/46",[106,5.288]],["title/47",[18,2.717,50,2.476]],["description/47",[107,5.288]],["title/48",[108,6.127]],["description/48",[1,2.101,67,1.456,109,2.886]],["title/49",[18,1.8,67,1.51,68,1.244,74,1.69,109,2.993]],["description/49",[110,5.288]],["title/50",[68,1.604,111,3.861,112,4.349]],["description/50",[113,5.288]],["title/51",[69,2.001,114,4.349,115,4.349]],["description/51",[116,5.288]],["title/52",[117,5.439]],["description/52",[31,1.563,118,2.593,119,1.829,120,1.829,121,1.829]],["title/53",[11,3.448,122,3.148]],["description/53",[117,4.695]],["title/54",[11,3.448,122,3.148]],["description/54",[123,5.288]],["title/55",[69,1.747,124,3.798,125,3.798,126,3.798]],["description/55",[127,5.288]],["title/56",[122,2.691,128,4.349,129,4.349]],["description/56",[130,5.288]],["title/57",[67,1.948,131,3.861,132,2.948]],["description/57",[133,5.288]],["title/58",[67,1.948,132,2.948,134,3.861]],["description/58",[135,5.288]],["title/59",[67,1.948,132,2.948,134,3.861]],["description/59",[136,5.288]],["title/60",[137,5.439]],["description/60",[137,4.695]],["title/61",[18,2.028,19,3.372,67,1.701,68,1.401]],["description/61",[138,5.288]],["title/62",[139,5.439]],["description/62",[1,2.101,67,1.456,139,2.886]],["title/63",[67,1.701,122,2.35,132,2.574,140,3.372]],["description/63",[141,5.288]],["title/64",[142,5.439]],["description/64",[143,2.886,144,2.886,145,2.466]],["title/65",[68,1.401,143,3.372,144,3.372,146,3.798]],["description/65",[147,5.288]],["title/66",[31,2.881,142,3.372,148,3.798,149,2.881]],["description/66",[150,5.288]],["title/67",[151,6.127]],["description/67",[152,2.466,153,2.886,154,2.101]],["title/68",[68,1.015,118,2.088,155,1.779,156,2.79,157,2.752,158,2.752]],["description/68",[159,5.288]],["title/69",[160,4.986]],["description/69",[1,2.101,152,2.466,160,2.646]],["title/70",[68,1.401,69,1.747,160,3.091,161,2.455]],["description/70",[162,5.288]],["title/71",[163,5.439]],["description/71",[31,1.563,118,2.593,119,1.829,120,1.829,121,1.829]],["title/72",[68,1.877,164,4.516]],["description/72",[163,4.695]],["title/73",[68,1.877,164,4.516]],["description/73",[165,5.288]],["title/74",[13,3.539,16,3.861,68,1.604]],["description/74",[166,5.288]],["title/75",[167,4.152]],["description/75",[1,1.762,18,1.456,118,2.068,167,1.848]],["title/76",[2,3.539,11,2.948,74,2.181]],["description/76",[168,4.695]],["title/77",[122,3.148,167,3.448]],["description/77",[167,3.584]],["title/78",[11,2.948,167,2.948,169,3.861]],["description/78",[170,5.288]],["title/79",[11,2.948,167,2.948,169,3.861]],["description/79",[171,5.288]],["title/80",[74,1.904,96,2.455,172,3.798,173,3.798]],["description/80",[174,5.288]],["title/81",[5,2.993,155,2.179,161,2.179,175,3.371,176,3.371]],["description/81",[177,5.288]],["title/82",[155,3.96]],["description/82",[178,5.288]],["title/83",[155,3.96]],["description/83",[179,5.288]],["title/84",[155,3.288,180,4.516]],["description/84",[181,5.288]],["title/85",[74,2.551,182,5.087]],["description/85",[183,5.288]],["title/86",[69,2.341,155,3.288]],["description/86",[184,5.288]],["title/87",[74,1.904,185,3.372,186,3.798,187,3.798]],["description/87",[168,4.695]],["title/88",[188,5.087,189,5.087]],["description/88",[190,5.288]],["title/89",[132,2.948,140,3.861,155,2.811]],["description/89",[191,5.288]],["title/90",[122,2.691,192,4.349,193,4.349]],["description/90",[194,5.288]],["title/91",[195,6.127]],["description/91",[50,1.583,196,2.886,197,3.251]],["title/92",[50,2.476,198,5.087]],["description/92",[199,5.288]],["title/93",[200,6.127]],["description/93",[6,1.339,149,4.206,201,1.508]],["title/94",[18,2.028,67,1.701,68,1.401,74,1.904]],["description/94",[202,5.288]],["title/95",[203,6.127]],["description/95",[74,0.831,149,3.359,204,1.47,205,1.656,206,1.656]],["title/96",[18,2.028,50,1.849,67,1.701,68,1.401]],["description/96",[207,5.288]],["title/97",[208,6.127]],["description/97",[69,0.637,149,4.269,209,1.385]],["title/98",[18,2.028,50,1.849,67,1.701,68,1.401]],["description/98",[210,5.288]],["title/99",[211,6.127]],["description/99",[74,1.556,122,1.136,204,1.63,212,1.837,213,1.837,214,1.837]],["title/100",[122,3.148,180,4.516]],["description/100",[215,5.288]],["title/101",[216,5.439]],["description/101",[216,4.695]],["title/102",[18,2.028,50,1.849,67,1.701,68,1.401]],["description/102",[217,5.288]],["title/103",[218,6.127]],["description/103",[196,2.42,219,2.726,220,2.726,221,2.726]],["title/104",[67,1.948,68,1.604,74,2.181]],["description/104",[222,5.288]],["title/105",[223,6.127]],["description/105",[152,2.466,153,2.886,154,2.101]],["title/106",[145,2.881,154,2.455,224,2.881,225,3.372]],["description/106",[226,5.288]],["title/107",[145,2.557,154,2.179,224,2.557,225,2.993,227,2.993]],["description/107",[228,5.288]],["title/108",[53,3.539,154,2.811,224,3.299]],["description/108",[229,5.288]],["title/109",[53,2.743,145,2.557,154,2.179,224,2.557,227,2.993]],["description/109",[230,5.288]],["title/110",[111,3.372,154,2.455,231,3.798,232,3.798]],["description/110",[233,5.288]],["title/111",[29,3.148,234,3.635]],["description/111",[235,5.288]],["title/112",[161,3.288,234,3.635]],["description/112",[236,5.288]],["title/113",[161,3.288,234,3.635]],["description/113",[237,5.288]],["title/114",[161,3.288,234,3.635]],["description/114",[238,5.288]],["title/115",[161,3.288,234,3.635]],["description/115",[239,5.288]],["title/116",[46,2.811,50,2.117,240,3.539]],["description/116",[241,5.288]],["title/117",[28,1.233,49,1.966,50,2.101,69,1.266,240,2.24,242,2.24]],["description/117",[243,5.288]],["title/118",[28,1.129,49,1.801,50,1.96,131,2.238,240,2.051,242,2.051,244,2.238]],["description/118",[245,5.288]],["title/119",[28,1.51,49,2.408,50,1.641,69,1.551,242,2.743]],["description/119",[246,5.288]],["title/120",[50,2.117,161,2.811,247,4.349]],["description/120",[248,5.288]],["title/121",[28,1.948,29,2.691,50,2.117]],["description/121",[249,5.288]],["title/122",[28,1.948,49,3.107,50,2.117]],["description/122",[250,5.288]],["title/123",[28,1.701,46,2.455,47,2.574,251,3.798]],["description/123",[252,5.288]],["title/124",[28,1.701,40,3.372,46,2.455,47,2.574]],["description/124",[253,5.288]],["title/125",[28,1.701,46,2.455,47,2.574,50,1.849]],["description/125",[254,5.288]],["title/126",[28,1.948,46,2.811,47,2.948]],["description/126",[255,5.288]],["title/127",[28,1.948,46,2.811,47,2.948]],["description/127",[256,5.288]],["title/128",[257,6.127]],["description/128",[152,3.055,258,2.305]],["title/129",[258,2.912,259,3.448]],["description/129",[260,5.288]],["title/130",[258,2.912,259,3.448]],["description/130",[261,5.288]],["title/131",[258,2.489,259,2.948,262,3.861]],["description/131",[263,5.288]],["title/132",[156,2.811,258,2.489,259,2.948]],["description/132",[264,5.288]],["title/133",[156,2.811,258,2.489,259,2.948]],["description/133",[265,5.288]],["title/134",[156,2.455,258,2.174,259,2.574,262,3.372]],["description/134",[266,5.288]],["title/135",[156,3.559,185,3.372,258,2.174]],["description/135",[267,5.288]],["title/136",[21,3.861,156,2.811,258,2.489]],["description/136",[268,5.288]],["title/137",[156,2.811,244,3.861,258,2.489]],["description/137",[269,5.288]],["title/138",[270,6.127]],["description/138",[271,5.288]],["title/139",[272,5.087,273,5.087]],["description/139",[274,5.288]],["title/140",[132,4.152]],["description/140",[275,5.288]]],"invertedIndex":[["",{"_index":149,"title":{"66":{}},"description":{"93":{},"95":{},"97":{}}}],["access",{"_index":1,"title":{},"description":{"0":{},"28":{},"32":{},"48":{},"62":{},"69":{},"75":{}}}],["add",{"_index":124,"title":{"55":{}},"description":{}}],["alarm",{"_index":22,"title":{"7":{}},"description":{}}],["aliv",{"_index":85,"title":{"35":{}},"description":{}}],["analys",{"_index":205,"title":{},"description":{"95":{}}}],["anoth",{"_index":214,"title":{},"description":{"99":{}}}],["api",{"_index":152,"title":{},"description":{"67":{},"69":{},"105":{},"128":{}}}],["auth",{"_index":52,"title":{"19":{}},"description":{"19":{}}}],["auth.dropsess",{"_index":64,"title":{"25":{}},"description":{}}],["auth.getsess",{"_index":62,"title":{"24":{}},"description":{}}],["auth.islog",{"_index":60,"title":{"23":{}},"description":{}}],["auth.login",{"_index":54,"title":{"20":{}},"description":{}}],["auth.loginbykerbero",{"_index":56,"title":{"21":{}},"description":{}}],["auth.logout",{"_index":58,"title":{"22":{}},"description":{}}],["auth/log",{"_index":61,"title":{},"description":{"23":{}}}],["auth/login",{"_index":55,"title":{},"description":{"20":{}}}],["auth/login/kerbero",{"_index":57,"title":{},"description":{"21":{}}}],["auth/logout",{"_index":59,"title":{},"description":{"22":{}}}],["auth/sess",{"_index":63,"title":{},"description":{"24":{}}}],["auth/session/{id",{"_index":65,"title":{},"description":{"25":{}}}],["bridg",{"_index":67,"title":{"29":{},"33":{},"49":{},"57":{},"58":{},"59":{},"61":{},"63":{},"94":{},"96":{},"98":{},"102":{},"104":{}},"description":{"26":{},"28":{},"32":{},"48":{},"62":{}}}],["burevestnik",{"_index":66,"title":{"26":{}},"description":{"26":{}}}],["burevestnik/top",{"_index":71,"title":{},"description":{"27":{}}}],["cabinet",{"_index":201,"title":{},"description":{"93":{}}}],["cach",{"_index":10,"title":{"3":{},"4":{},"5":{}},"description":{}}],["calc",{"_index":140,"title":{"63":{},"89":{}},"description":{}}],["calcul",{"_index":139,"title":{"62":{}},"description":{"62":{}}}],["calculator/test",{"_index":141,"title":{},"description":{"63":{}}}],["chang",{"_index":42,"title":{"15":{}},"description":{}}],["check",{"_index":49,"title":{"18":{},"117":{},"118":{},"119":{},"122":{}},"description":{}}],["client",{"_index":187,"title":{"87":{}},"description":{}}],["cmdb",{"_index":5,"title":{"2":{},"81":{}},"description":{}}],["collector_modbu",{"_index":72,"title":{"28":{}},"description":{}}],["collector_p",{"_index":76,"title":{"30":{}},"description":{}}],["collector_pings/getpingobj",{"_index":79,"title":{},"description":{"31":{}}}],["collector_snmp",{"_index":80,"title":{"32":{}},"description":{}}],["collector_snmps/getoid",{"_index":92,"title":{},"description":{"38":{}}}],["collector_snmps/getstatet",{"_index":91,"title":{},"description":{"37":{}}}],["collector_snmps/gett",{"_index":90,"title":{},"description":{"36":{}}}],["collector_snmps/querystateoid",{"_index":93,"title":{},"description":{"39":{}}}],["collector_snmps/reject",{"_index":88,"title":{},"description":{"35":{}}}],["collector_snmps/st",{"_index":82,"title":{},"description":{"33":{}}}],["collector_snmps/work",{"_index":84,"title":{},"description":{"34":{}}}],["collector_wmi",{"_index":108,"title":{"48":{}},"description":{}}],["command",{"_index":232,"title":{"110":{}},"description":{}}],["conf",{"_index":234,"title":{"111":{},"112":{},"113":{},"114":{},"115":{}},"description":{}}],["config",{"_index":50,"title":{"18":{},"47":{},"92":{},"96":{},"98":{},"102":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"125":{}},"description":{"91":{}}}],["configur",{"_index":153,"title":{},"description":{"67":{},"105":{}}}],["connect",{"_index":103,"title":{"44":{}},"description":{}}],["control",{"_index":126,"title":{"55":{}},"description":{}}],["count",{"_index":247,"title":{"120":{}},"description":{}}],["counter",{"_index":182,"title":{"85":{}},"description":{}}],["creator",{"_index":197,"title":{},"description":{"91":{}}}],["cross",{"_index":102,"title":{"44":{}},"description":{}}],["current",{"_index":18,"title":{"6":{},"29":{},"33":{},"34":{},"47":{},"49":{},"61":{},"94":{},"96":{},"98":{},"102":{}},"description":{"75":{}}}],["data",{"_index":118,"title":{"68":{}},"description":{"52":{},"71":{},"75":{}}}],["data_book",{"_index":117,"title":{"52":{}},"description":{"53":{}}}],["data_book/cmdb/sync",{"_index":136,"title":{},"description":{"59":{}}}],["data_book/pol",{"_index":127,"title":{},"description":{"55":{}}}],["data_book/polling/lit",{"_index":130,"title":{},"description":{"56":{}}}],["data_book/test/progress",{"_index":135,"title":{},"description":{"58":{}}}],["data_book/test/run",{"_index":133,"title":{},"description":{"57":{}}}],["data_book/{id",{"_index":123,"title":{},"description":{"54":{}}}],["databas",{"_index":157,"title":{"68":{}},"description":{}}],["devic",{"_index":69,"title":{"27":{},"31":{},"37":{},"39":{},"41":{},"42":{},"43":{},"45":{},"46":{},"51":{},"55":{},"70":{},"86":{},"117":{},"119":{}},"description":{"30":{},"97":{}}}],["dhcp",{"_index":25,"title":{"8":{}},"description":{"8":{}}}],["dhcp/addztplist",{"_index":32,"title":{},"description":{"9":{}}}],["dhcp/changejinjapattern",{"_index":41,"title":{},"description":{"14":{}}}],["dhcp/changeoptpattern",{"_index":38,"title":{},"description":{"12":{}}}],["dhcp/deleterecord",{"_index":45,"title":{},"description":{"16":{}}}],["dhcp/findfil",{"_index":51,"title":{},"description":{"18":{}}}],["dhcp/getpatternfilejinja2",{"_index":48,"title":{},"description":{"17":{}}}],["dhcp/gettabl",{"_index":39,"title":{},"description":{"13":{}}}],["dhcp/showoptpattern",{"_index":37,"title":{},"description":{"11":{}}}],["dhcp/showztplist",{"_index":34,"title":{},"description":{"10":{}}}],["dhcp/startztp",{"_index":44,"title":{},"description":{"15":{}}}],["dj",{"_index":142,"title":{"64":{},"66":{}},"description":{}}],["dj/record",{"_index":147,"title":{},"description":{"65":{}}}],["dj/synclist",{"_index":150,"title":{},"description":{"66":{}}}],["dolt",{"_index":240,"title":{"116":{},"117":{},"118":{}},"description":{}}],["drop",{"_index":192,"title":{"90":{}},"description":{}}],["duti",{"_index":143,"title":{"65":{}},"description":{"64":{}}}],["dynam",{"_index":196,"title":{},"description":{"91":{},"103":{}}}],["ex",{"_index":173,"title":{"80":{}},"description":{}}],["execut",{"_index":111,"title":{"50":{},"110":{}},"description":{}}],["extern",{"_index":212,"title":{},"description":{"99":{}}}],["extstat",{"_index":193,"title":{"90":{}},"description":{}}],["field",{"_index":220,"title":{},"description":{"103":{}}}],["file",{"_index":47,"title":{"17":{},"123":{},"124":{},"125":{},"126":{},"127":{}},"description":{}}],["filter",{"_index":262,"title":{"131":{},"134":{}},"description":{}}],["flag",{"_index":43,"title":{"15":{}},"description":{}}],["folder",{"_index":6,"title":{"2":{}},"description":{"93":{}}}],["ftp",{"_index":271,"title":{},"description":{"138":{}}}],["ftp_server",{"_index":270,"title":{"138":{}},"description":{}}],["ftp_server/geturl",{"_index":274,"title":{},"description":{"139":{}}}],["ftp_server/test",{"_index":275,"title":{},"description":{"140":{}}}],["full",{"_index":169,"title":{"78":{},"79":{}},"description":{}}],["function",{"_index":145,"title":{"106":{},"107":{},"109":{}},"description":{"64":{}}}],["gener",{"_index":198,"title":{"92":{}},"description":{}}],["give",{"_index":272,"title":{"139":{}},"description":{}}],["historian",{"_index":151,"title":{"67":{}},"description":{}}],["historian/measur",{"_index":159,"title":{},"description":{"68":{}}}],["id",{"_index":161,"title":{"70":{},"81":{},"112":{},"113":{},"114":{},"115":{},"120":{}},"description":{}}],["imag",{"_index":251,"title":{"123":{}},"description":{}}],["info",{"_index":11,"title":{"3":{},"53":{},"54":{},"76":{},"78":{},"79":{}},"description":{}}],["init",{"_index":4,"title":{"2":{}},"description":{}}],["inventori",{"_index":96,"title":{"42":{},"43":{},"44":{},"45":{},"46":{},"80":{}},"description":{"40":{}}}],["jinja",{"_index":40,"title":{"14":{},"124":{}},"description":{}}],["journal",{"_index":144,"title":{"65":{}},"description":{"64":{}}}],["licens",{"_index":160,"title":{"69":{},"70":{}},"description":{"69":{}}}],["license/deviceid",{"_index":162,"title":{},"description":{"70":{}}}],["limit",{"_index":89,"title":{"36":{}},"description":{}}],["link",{"_index":213,"title":{},"description":{"99":{}}}],["list",{"_index":31,"title":{"9":{},"66":{}},"description":{"52":{},"71":{}}}],["log",{"_index":164,"title":{"72":{},"73":{}},"description":{}}],["logs_enod",{"_index":163,"title":{"71":{}},"description":{"72":{}}}],["logs_enode/count",{"_index":165,"title":{},"description":{"73":{}}}],["logs_enode/tag",{"_index":166,"title":{},"description":{"74":{}}}],["long",{"_index":120,"title":{},"description":{"52":{},"71":{}}}],["look",{"_index":114,"title":{"51":{}},"description":{}}],["map",{"_index":180,"title":{"84":{},"100":{}},"description":{}}],["mapper",{"_index":221,"title":{},"description":{"103":{}}}],["measur",{"_index":155,"title":{"68":{},"81":{},"82":{},"83":{},"84":{},"86":{},"89":{}},"description":{}}],["measure$1",{"_index":176,"title":{"81":{}},"description":{}}],["measure(",{"_index":188,"title":{"88":{}},"description":{}}],["method",{"_index":28,"title":{"9":{},"11":{},"12":{},"14":{},"15":{},"16":{},"17":{},"18":{},"117":{},"118":{},"119":{},"121":{},"122":{},"123":{},"124":{},"125":{},"126":{},"127":{}},"description":{}}],["mirror",{"_index":167,"title":{"75":{},"77":{},"78":{},"79":{}},"description":{"75":{},"77":{}}}],["mirror/al",{"_index":170,"title":{},"description":{"78":{}}}],["mirror/device/{id}/measur",{"_index":184,"title":{},"description":{"86":{}}}],["mirror/dropextst",{"_index":194,"title":{},"description":{"90":{}}}],["mirror/map",{"_index":181,"title":{},"description":{"84":{}}}],["mirror/measur",{"_index":178,"title":{},"description":{"82":{}}}],["mirror/measure/stat",{"_index":190,"title":{},"description":{"88":{}}}],["mirror/measure/testcalc",{"_index":191,"title":{},"description":{"89":{}}}],["mirror/measure/{id",{"_index":177,"title":{},"description":{"81":{}}}],["mirror/row",{"_index":179,"title":{},"description":{"83":{}}}],["mirror/st",{"_index":168,"title":{},"description":{"76":{},"87":{}}}],["mirror/state/count",{"_index":183,"title":{},"description":{"85":{}}}],["mirror/statesbyprefix",{"_index":174,"title":{},"description":{"80":{}}}],["mirror/{id",{"_index":171,"title":{},"description":{"79":{}}}],["modbu",{"_index":73,"title":{"29":{}},"description":{"28":{}}}],["modbus/st",{"_index":75,"title":{},"description":{"29":{}}}],["model",{"_index":53,"title":{"108":{},"109":{}},"description":{"19":{}}}],["modul",{"_index":115,"title":{"51":{}},"description":{}}],["node",{"_index":2,"title":{"6":{},"76":{}},"description":{"0":{}}}],["node_act",{"_index":195,"title":{"91":{}},"description":{}}],["node_actions/getsubinterfac",{"_index":199,"title":{},"description":{"92":{}}}],["node_serv",{"_index":137,"title":{"60":{}},"description":{"60":{}}}],["node_server/statu",{"_index":138,"title":{},"description":{"61":{}}}],["obj",{"_index":78,"title":{"31":{}},"description":{}}],["object",{"_index":122,"title":{"53":{},"54":{},"56":{},"63":{},"77":{},"90":{},"100":{}},"description":{"99":{}}}],["oid",{"_index":87,"title":{"35":{},"36":{},"38":{}},"description":{}}],["on",{"_index":227,"title":{"107":{},"109":{}},"description":{}}],["option",{"_index":35,"title":{"11":{},"12":{}},"description":{}}],["pattern",{"_index":36,"title":{"11":{},"12":{},"14":{}},"description":{}}],["ping",{"_index":77,"title":{"31":{}},"description":{"30":{}}}],["port|module|slot",{"_index":209,"title":{},"description":{"97":{}}}],["prefix",{"_index":172,"title":{"80":{}},"description":{}}],["progress",{"_index":134,"title":{"58":{},"59":{}},"description":{}}],["queri",{"_index":68,"title":{"27":{},"29":{},"33":{},"34":{},"37":{},"39":{},"41":{},"42":{},"43":{},"44":{},"45":{},"46":{},"49":{},"50":{},"61":{},"65":{},"68":{},"70":{},"72":{},"73":{},"74":{},"94":{},"96":{},"98":{},"102":{},"104":{}},"description":{}}],["record",{"_index":146,"title":{"65":{}},"description":{}}],["ref",{"_index":204,"title":{},"description":{"95":{},"99":{}}}],["regist",{"_index":97,"title":{"41":{}},"description":{}}],["reject",{"_index":86,"title":{"35":{}},"description":{}}],["remov",{"_index":15,"title":{"5":{}},"description":{}}],["renew",{"_index":125,"title":{"55":{}},"description":{}}],["repol",{"_index":128,"title":{"56":{}},"description":{}}],["reset",{"_index":9,"title":{"3":{}},"description":{}}],["role",{"_index":129,"title":{"56":{}},"description":{}}],["rom",{"_index":186,"title":{"87":{}},"description":{}}],["run",{"_index":131,"title":{"57":{},"118":{}},"description":{}}],["search",{"_index":224,"title":{"106":{},"107":{},"108":{},"109":{}},"description":{}}],["send",{"_index":46,"title":{"17":{},"116":{},"123":{},"124":{},"125":{},"126":{},"127":{}},"description":{}}],["server",{"_index":23,"title":{"7":{}},"description":{}}],["servic",{"_index":0,"title":{"0":{}},"description":{"0":{},"1":{}}}],["service.getservic",{"_index":3,"title":{"1":{}},"description":{}}],["services/cache/drop",{"_index":12,"title":{},"description":{"3":{}}}],["services/cache/get",{"_index":14,"title":{},"description":{"4":{}}}],["services/cache/removetag",{"_index":17,"title":{},"description":{"5":{}}}],["services/initcmdbstructur",{"_index":8,"title":{},"description":{"2":{}}}],["services/nodestatu",{"_index":20,"title":{},"description":{"6":{}}}],["services/stop",{"_index":24,"title":{},"description":{"7":{}}}],["show",{"_index":259,"title":{"129":{},"130":{},"131":{},"132":{},"133":{},"134":{}},"description":{}}],["singl",{"_index":175,"title":{"81":{}},"description":{}}],["sniff",{"_index":26,"title":{},"description":{"8":{}}}],["snmp",{"_index":81,"title":{"33":{}},"description":{"32":{}}}],["start",{"_index":244,"title":{"118":{},"137":{}},"description":{}}],["stat",{"_index":189,"title":{"88":{}},"description":{}}],["state",{"_index":74,"title":{"29":{},"33":{},"34":{},"37":{},"39":{},"49":{},"76":{},"80":{},"85":{},"87":{},"94":{},"104":{}},"description":{"95":{},"99":{}}}],["state_ref",{"_index":200,"title":{"93":{}},"description":{}}],["state_ref/st",{"_index":202,"title":{},"description":{"94":{}}}],["state_ref5",{"_index":211,"title":{"99":{}},"description":{}}],["state_ref5/map",{"_index":215,"title":{},"description":{"100":{}}}],["state_ref_2",{"_index":203,"title":{"95":{}},"description":{}}],["state_ref_2/config",{"_index":207,"title":{},"description":{"96":{}}}],["state_ref_4",{"_index":208,"title":{"97":{}},"description":{}}],["state_ref_4/config",{"_index":210,"title":{},"description":{"98":{}}}],["state_unknown",{"_index":216,"title":{"101":{}},"description":{"101":{}}}],["state_unknown/config",{"_index":217,"title":{},"description":{"102":{}}}],["static",{"_index":219,"title":{},"description":{"103":{}}}],["static_field",{"_index":218,"title":{"103":{}},"description":{}}],["static_fields/st",{"_index":222,"title":{},"description":{"104":{}}}],["statu",{"_index":19,"title":{"6":{},"61":{}},"description":{}}],["step",{"_index":158,"title":{"68":{}},"description":{}}],["stop",{"_index":21,"title":{"7":{},"136":{}},"description":{}}],["storag",{"_index":121,"title":{},"description":{"52":{},"71":{}}}],["store",{"_index":119,"title":{},"description":{"52":{},"71":{}}}],["structur",{"_index":7,"title":{"2":{}},"description":{}}],["switch",{"_index":154,"title":{"106":{},"107":{},"108":{},"109":{},"110":{}},"description":{"67":{},"105":{}}}],["switch_set",{"_index":223,"title":{"105":{}},"description":{}}],["switch_settings/swset/checksyncallconfigsfordevic",{"_index":246,"title":{},"description":{"119":{}}}],["switch_settings/swset/checksyncdoltfordevic",{"_index":243,"title":{},"description":{"117":{}}}],["switch_settings/swset/checksyncstartandrunningfordevic",{"_index":245,"title":{},"description":{"118":{}}}],["switch_settings/swset/deviceconfig",{"_index":235,"title":{},"description":{"111":{}}}],["switch_settings/swset/devicefil",{"_index":249,"title":{},"description":{"121":{}}}],["switch_settings/swset/execcommand",{"_index":233,"title":{},"description":{"110":{}}}],["switch_settings/swset/findfil",{"_index":250,"title":{},"description":{"122":{}}}],["switch_settings/swset/getcommitsbyid",{"_index":237,"title":{},"description":{"113":{}}}],["switch_settings/swset/getconfigbycommit",{"_index":238,"title":{},"description":{"114":{}}}],["switch_settings/swset/getconfigbyid",{"_index":236,"title":{},"description":{"112":{}}}],["switch_settings/swset/getconfigfil",{"_index":255,"title":{},"description":{"126":{}}}],["switch_settings/swset/getcountofconfig",{"_index":248,"title":{},"description":{"120":{}}}],["switch_settings/swset/getdiffsbycommit",{"_index":239,"title":{},"description":{"115":{}}}],["switch_settings/swset/getstaticfil",{"_index":256,"title":{},"description":{"127":{}}}],["switch_settings/swset/putconfig",{"_index":254,"title":{},"description":{"125":{}}}],["switch_settings/swset/putimag",{"_index":252,"title":{},"description":{"123":{}}}],["switch_settings/swset/putjinja",{"_index":253,"title":{},"description":{"124":{}}}],["switch_settings/swset/searchfunct",{"_index":226,"title":{},"description":{"106":{}}}],["switch_settings/swset/searchfunctionsforprefix",{"_index":228,"title":{},"description":{"107":{}}}],["switch_settings/swset/searchmethod",{"_index":230,"title":{},"description":{"109":{}}}],["switch_settings/swset/searchtempl",{"_index":229,"title":{},"description":{"108":{}}}],["switch_settings/swset/sendconfigtodolt",{"_index":241,"title":{},"description":{"116":{}}}],["sync",{"_index":148,"title":{"66":{}},"description":{}}],["synchron",{"_index":242,"title":{"117":{},"118":{},"119":{}},"description":{}}],["tabl",{"_index":33,"title":{"10":{},"13":{},"16":{},"36":{},"37":{},"39":{}},"description":{}}],["tag",{"_index":16,"title":{"5":{},"74":{}},"description":{}}],["task",{"_index":258,"title":{"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{}},"description":{"128":{}}}],["task_manag",{"_index":257,"title":{"128":{}},"description":{}}],["task_manager/showalltask",{"_index":261,"title":{},"description":{"130":{}}}],["task_manager/showalltimetask",{"_index":265,"title":{},"description":{"133":{}}}],["task_manager/showtask",{"_index":260,"title":{},"description":{"129":{}}}],["task_manager/showtaskwithfilt",{"_index":263,"title":{},"description":{"131":{}}}],["task_manager/showtimetask",{"_index":264,"title":{},"description":{"132":{}}}],["task_manager/showtimetaskwithfilt",{"_index":266,"title":{},"description":{"134":{}}}],["task_manager/swset/starttimetask",{"_index":269,"title":{},"description":{"137":{}}}],["task_manager/swset/stoptimetask",{"_index":268,"title":{},"description":{"136":{}}}],["task_manager/swset/updatetimetask",{"_index":267,"title":{},"description":{"135":{}}}],["test",{"_index":132,"title":{"57":{},"58":{},"59":{},"63":{},"89":{},"140":{}},"description":{}}],["time",{"_index":156,"title":{"68":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{}},"description":{}}],["topic",{"_index":70,"title":{"27":{}},"description":{}}],["traffic",{"_index":27,"title":{},"description":{"8":{}}}],["transmit",{"_index":231,"title":{"110":{}},"description":{}}],["type",{"_index":225,"title":{"106":{},"107":{}},"description":{}}],["umux",{"_index":98,"title":{"41":{}},"description":{}}],["unem",{"_index":95,"title":{},"description":{"40":{}}}],["unem_inventori",{"_index":94,"title":{"40":{}},"description":{}}],["unem_inventory/config",{"_index":107,"title":{},"description":{"47":{}}}],["unem_inventory/devic",{"_index":99,"title":{},"description":{"41":{}}}],["unem_inventory/inventori",{"_index":105,"title":{},"description":{"45":{}}}],["unem_inventory/inventory/crossconnect",{"_index":104,"title":{},"description":{"44":{}}}],["unem_inventory/inventory/modul",{"_index":100,"title":{},"description":{"42":{}}}],["unem_inventory/inventory/port",{"_index":101,"title":{},"description":{"43":{}}}],["unem_inventory/publish",{"_index":106,"title":{},"description":{"46":{}}}],["updat",{"_index":185,"title":{"87":{},"135":{}},"description":{}}],["url",{"_index":273,"title":{"139":{}},"description":{}}],["v2",{"_index":206,"title":{},"description":{"95":{}}}],["valu",{"_index":13,"title":{"4":{},"38":{},"74":{}},"description":{}}],["wmi",{"_index":109,"title":{"49":{}},"description":{"48":{}}}],["wmi/inventori",{"_index":116,"title":{},"description":{"51":{}}}],["wmi/stat",{"_index":110,"title":{},"description":{"49":{}}}],["wmi/wql",{"_index":113,"title":{},"description":{"50":{}}}],["work",{"_index":29,"title":{"9":{},"11":{},"12":{},"14":{},"15":{},"16":{},"111":{},"121":{}},"description":{}}],["worker",{"_index":83,"title":{"34":{}},"description":{}}],["wql",{"_index":112,"title":{"50":{}},"description":{}}],["ztp",{"_index":30,"title":{"9":{}},"description":{}}]],"pipeline":[]}},"options":{}};
   var container = document.getElementById('redoc');
   Redoc.hydrate(__redoc_state, container);
   </script>