ON PREMISES SOLUTIONS

getSandboxAnalyzerInstancesList

This method lists the instances in the Infrastructure menu.

Parameters

Parameter

Type

Optional

Description

page

Number

Yes

The results page. Default value: 1.

perPage

Number

Yes

The number of items displayed per page. The upper limit is 100 items per page. Default value: 30.

Return value

This method returns an Object containing information regarding the [SandboxAnalyzer] instances. The object has the following structure:

  • page - the current page displayed

  • pagesCount - the total number of available pages

  • perPage - the number of returned items per page

  • items - the list of [SandboxAnalyzer] instances. Each item has the following fields:

    • sandboxId, the ID of the [SandboxAnalyzer] instance.

    • name, the name of the [SandboxAnalyzer] instance.

    • ip, the IP address of the [SandboxAnalyzer] instance.

    • macs, the MAC addresses of the [SandboxAnalyzer] instance.

    • ssid, the Active Directory SID of the [SandboxAnalyzer] instance.

    • detonatedSamples, the overall number of samples analyzed by the [SandboxAnalyzer] instance.

    • diskUsage, the percentage of the disk space that [SandboxAnalyzer] occupies in the datastore.

    • installationStatus, the status of the [SandboxAnalyzer] installation process. It can have one of the following values:

      • 0 - Not installed

      • 1 - Installed

      • 2 - Installing

      • 3 - Installation failed

    • lastSeen, the date of the last synchronization with Control Center.

    • configuredConcurrentDetonations, the number of virtual machines allocated to detonate samples.

    • maximumConcurrentDetonations, the maximum number of virtual machines that the [SandboxAnalyzer] instance can create to detonate samples.

    • submissionUrl, the URL for submitting files for analysis.

  • total - the total number of items

Example

Request:

  {
     "method": "getSandboxAnalyzerInstancesList",
     "params": {
        "page": 1,
        "perPage": 20
     },
     "jsonrpc": "2.0",
     "id": "91d6430d-bfd4-494f-8d4d-4947406d21a7"
  }   

Response:

  {
     "id": "91d6430d-bfd4-494f-8d4d-4947406d21a7",
     "jsonrpc": "2.0",
     "result": {
        "page": 1,
        "pagesCount": 1,
        "perPage": 20,
        "total": 1,
        "items": [
           {
               "sandboxId": "5c419e6e26df3d367c49de18",
               "name": "sandbox1",
               "ip": "10.10.20.1",
               "macs": [
                   "00-14-22-01-23-45"
               ],
               "ssid": "",
               "detonatedSamples": 0,
               "diskUsage": 250,
               "installationStatus": 1,
               "lastSeen": "2019-01-18T11:37:50",
               "configuredConcurrentDetonations": 0,
               "maximumConcurrentDetonations": 10,
               "submissionUrl":"https://10.10.20.1:443/api/v1/upload"
           }
        ]
     }
  }