Snowpacks data info

• Access to inventory device data
  • getGet inventory device metadata
  • getGet inventory device data
  • getGet installed device software

API docs by Redocly

Support: Snowpacks data (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with ingested inventory data.

Access to inventory device data

Get inventory device metadata

Returns a collection of inventory metadata based on the filter criteria.

query Parameters

filter	string Filter the collection of device metadata. Example: filter=status -eq 'active' For more information on the available operators and which data types those operators work on, see Filter API call results.
page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.

Responses

https://{region}.snowsoftware.io/api/inventory/v1/device/metadata

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  },
• "items": [

  • {

    • "tenantId": "b814cda1-2c2a-455c-b288-57b642982eb0",
    • "hostname": "Client001",
    • "originalBlobId": "d7165920-b415-4a25-bfd9-522a16c2133e",
    • "deviceId": "602e717c-d1ba-426b-9c58-1b4b4744ffd1",
    • "source": "agent-win32"

    }

  ],
• "_links": [

  • {

    • "href": "api/inventory/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get inventory device data

Returns the details of a single device document.

path Parameters

deviceId required

string The unique ID of the device.

query Parameters

filter

string Filter the device data. Example: filter=status -eq 'active' For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/inventory/v1/device/{deviceId}/data

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "tenantId": "b814cda1-2c2a-455c-b288-57b642982eb0",
• "deviceId": "602e717c-d1ba-426b-9c58-1b4b4744ffd1",
• "sources": [

  • {

    • "source": {

      • "name": "agent-win32",
      • "ingestionId": "d7165920-b415-4a25-bfd9-522a16c2133e"

      },
    • "client": {

      • "scannerVersion": "1.0.0",
      • "clientType": "Snow Agent - Windows",
      • "clientVersion": "6.7.0",
      • "site": "snow",
      • "company": "Test company",
      • "configName": "SnowSky"

      },
    • "deviceData": {

      • "hostname": "Client001",
      • "domain": "Domain001",
      • "manufacturerName": "Dell Inc.",
      • "model": "Precision 5550",
      • "userName": "EUSE\\afdnes",
      • "fullUserName": "N/A",
      • "manufacturerId": "N/A",
      • "lastScanDate": "2019-08-24T14:15:22Z",
      • "bios": {

        • "manufacturerName": "Dell Inc.",
        • "manufacturerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        • "serialNumber": "C2FD893",
        • "version": "1.6.1",
        • "releaseDate": "2019-08-24T14:15:22Z"

        },
      • "processor": {

        • "name": "Intel(R) Core(TM) i7-10850H CPU @ 2.70GHz",
        • "family": "Core i7.",
        • "manufacturerName": "Dell Inc.",
        • "manufacturerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        • "vendorIdentifier": "GenuineIntel",
        • "identifier": "Intel",
        • "processorId": "N/A",
        • "processorName": "Intel(R) Core(TM) i7-10850H",
        • "model": "Core i7-10850H",
        • "processorNameString": "Intel(R) Core(TM) i7-10850H",
        • "clockSpeedMhz": 2700,
        • "maxSpeedMhz": 3000,
        • "coreCount": 6,
        • "processorCount": 1,
        • "logicalProcessorCount": 1,
        • "hasHyperThreading": true,
        • "hasMmx": true,
        • "voltage": "1.8",
        • "hardwareFamilyId": "e83a470b-64e1-441c-87ef-b0e2e4fe94cf",
        • "hardwareSeriesId": "99d2cc10-a7ac-43e9-bb78-356965c288cb",
        • "hardwareModelId": "52f7b07f-6f2d-41f6-95e5-8f4c33cf53a0",
        • "hardwareVersionId": "9646809d-9b6d-4790-92d7-2dc687233c9e"

        },
      • "memory": {

        • "totalPhysicalKb": 2048,
        • "freePhysicalKb": 2048,
        • "modules": [

          • {

            • "type": "DDR SDRAM",
            • "sizeMb": 2048

            }

          ]

        },
      • "networkAdapters": [

        • {

          • "name": "Intel(R) Dual Band Wireless",
          • "ipAddress": "10.128.246.8",
          • "defaultGateway": "192.168.99.1",
          • "dhcpServer": "192.168.99.1",
          • "dhcpEnabled": true,
          • "dnsServer": "dns1.registrar-servers.com",
          • "macAddress": "C0:3C:59:10:B6:70",
          • "subnet": "255.255.255.0",
          • "manufacturerName": "Dell Inc.",
          • "manufacturerId": "c72d3f94-dee6-456f-a73e-4033588a44de"

          }

        ],
      • "videoAdapters": [

        • {

          • "name": "N/A",
          • "description": "N/A",
          • "manufacturerName": "N/A.",
          • "manufacturerId": "c72d3f94-dee6-456f-a73e-4033588a44de",
          • "hardwareFamilyId": "e83a470b-64e1-441c-87ef-b0e2e4fe94cf",
          • "hardwareSeriesId": "99d2cc10-a7ac-43e9-bb78-356965c288cb",
          • "hardwareModelId": "52f7b07f-6f2d-41f6-95e5-8f4c33cf53a0",
          • "hardwareVersionId": "9646809d-9b6d-4790-92d7-2dc687233c9e",
          • "videoProcessor": "N/A.",
          • "adapterRamKb": 2048,
          • "driverVersion": "2.4.3",
          • "driverDate": "2019-08-24T14:15:22Z"

          }

        ],
      • "logicalDrives": [

        • {

          • "name": "N/A",
          • "capacityMb": 2048,
          • "freeSpaceMb": 2048,
          • "logicalDriveType": "Local"

          }

        ],
      • "physicalDrives": [

        • {

          • "name": "N/A",
          • "interface": "N/A",
          • "capacityMb": 2048,
          • "partitions": 3

          }

        ],
      • "operatingSystem": {

        • "applicationId": "fdd02e3c-82b2-49a0-91c5-87d873dacf5c",
        • "name": "Windows",
        • "manufacturerName": "Microsoft",
        • "manufacturerId": "c72d3f94-dee6-456f-a73e-4033588a44de",
        • "version": "1.2.3",
        • "buildNumber": "3.4.5",
        • "buildType": "N/A",
        • "type": "NotReported"

        },
      • "keyboard": {

        • "layout": "N/A",
        • "name": "Logitech"

        },
      • "capabilities": {

        • "isVirtual": false,
        • "isServer": false,
        • "architecture": "N/A",
        • "hypervisorName": "N/A"

        }

      },
    • "identifiers": [

      • {

        • "source": "N/A",
        • "name": "N/A",
        • "value": "N/A"

        }

      ]

    }

  ]

}

Get installed device software

Returns the details of an installed software.

path Parameters

deviceId required

string The unique ID of the device.

query Parameters

filter

string Filter the device software data. Example: filter=status -eq 'active' For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/inventory/v1/device/{deviceId}/software

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "tenantId": "b814cda1-2c2a-455c-b288-57b642982eb0",
• "deviceId": "602e717c-d1ba-426b-9c58-1b4b4744ffd1",
• "sources": [

  • {

    • "source": {

      • "name": "agent-win32",
      • "ingestionId": "d7165920-b415-4a25-bfd9-522a16c2133e"

      },
    • "software": [

      • {

        • "applicationId": "6c8b1a41-58bc-4dd2-a31c-1604ba7ea720",
        • "ruleId": "56eedf2f-27e3-4667-a6bd-168752de3514",
        • "name": "Jira",
        • "manufacturer": "Atlasian",
        • "version": "5.4.4",
        • "executablePath": "N/A",
        • "osType": 1,
        • "isOs": true,
        • "isRegistry": true,
        • "isPreRecognized": true,
        • "metering": [

          • {

            • "counter": 5,
            • "day": "2019-08-24T14:15:22Z",
            • "deviceId": "N/A",
            • "domainName": "N/A",
            • "firstUsed": "2019-08-24T14:15:22Z",
            • "fullVersion": "2.6.6",
            • "isLocal": true,
            • "isWebApp": true,
            • "languageName": "N/A",
            • "lastUsed": "2019-08-24T14:15:22Z",
            • "manufacturer": "N/A",
            • "minutes": 10,
            • "name": "N/A",
            • "pathName": "N/A",
            • "regularAverage": 25,
            • "regularCount": 5,
            • "usageMask": 15,
            • "userName": "N/A",
            • "version": "4.7.8",
            • "isTs": true

            }

          ]

        }

      ]

    }

  ]

}