Skip to main content

getRootContainers

This method returns the root containers for a company. A root container refers to special groups, such as: Companies, Network, Computers and Groups.

Parameters

Parameter

Type

Optional

Description

companyId

String

Yes

The ID of the company for which the method will return the root containers. If null, the id of company linked to the API access key will be considered.

Return value

This method returns an Array containing the list of objects that represent the root containers. Each object has the following fields:

  • id - the ID of the root container

  • name - the name of the root container

Example

Request:

  {
       "params": {
           "companyId": "559bd17ab1a43d241b7b23c6"
       },
       "jsonrpc": "2.0",
       "method": "getRootContainers",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

Response:

  {
      "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": [
              {
                  "id" : "5582c385b1a43deb7f7b23c6",
                  "name" : "Companies"
              },
              {
                  "id" : "5582d3b3b1a43d897f7b23c8",
                  "name" : "Network"
              }
      ]
  }
In this section: