Skip to main content

Computers

API docs by Redocly

SAM: Computers (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for exploring computers.

Computers

Get computers

Returns a collection of computers.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer

Returns the details of a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer for which details will be returned.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "15764003-3c61-4d5f-9839-a63271240519",
  • "scanIdentifier": "Scan Identifier",
  • "hostName": "COMPUTER_1",
  • "domain": "Computer domain",
  • "lastScanDate": "2019-08-24T14:15:22Z",
  • "biosSerialNumber": "12345",
  • "biosVersion": "v2",
  • "biosDate": "2019-08-24T14:15:22Z",
  • "manufacturer": "Dell Inc.",
  • "model": "54321",
  • "isPortable": true,
  • "infoTransferDate": "2019-08-24T14:15:22Z",
  • "clientInstallDate": "2019-08-24T14:15:22Z",
  • "clientVersion": "v3",
  • "clientSiteName": "Site 1",
  • "clientConfigurationName": "Configuration 1",
  • "scannerVersion": "v5",
  • "quarantineDate": "2019-08-24T14:15:22Z",
  • "isQuarantineManagementDisabled": true,
  • "operatingSystem": "Windows 10",
  • "operatingSystemServicePack": "SP1",
  • "operatingSystemSerialNumber": "SN123456789",
  • "ipAddress": "208.80.154.224",
  • "isVirtual": true,
  • "hostComputerId": "80d640cc-9611-45c9-9782-6141994d2192",
  • "siblingComputerId": "f7e94458-d5df-4dcc-bcbb-a5b56e38ea84",
  • "isUpdated": true,
  • "is64bit": true,
  • "isServer": true,
  • "hypervisorName": "Hypervisor 1",
  • "isVdi": true,
  • "processorValueUnit": 4,
  • "reportingDate": "2019-08-24T14:15:22Z",
  • "architecture": "64-bit",
  • "organizationId": "b0b6c393-9d65-4642-9805-779d2fa24a23",
  • "status": "Active",
  • "isAutoEditingDisabled": true,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "purchaseValue": 3599,
  • "purchaseCurrency": "US Dollars",
  • "purchaseValueBase": 1000,
  • "invoiceReference": "INV1234",
  • "notes": "Five percent off for customer loyalty.",
  • "securityCode": "PASSWORD",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "isIncludedInWindowsServerRequirement": true,
  • "mostRecentUser": "00d5c098-965a-4f83-8903-9713a5eaa610",
  • "mostFrequentUser": "b7edf6ea-f28a-4621-912f-ff145dedcc7a",
  • "vendor": "Joe's Computers"
}

Get computer contracts

Returns a collection of contracts for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer costs

Returns the details of the costs for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer for which details of the costs will be returned.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
  • "vendor": "Joe's Computers",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "purchasePrice": 3499.99,
  • "purchaseCurrency": "US Dollars",
  • "invoiceReference": "INV1234",
  • "totalCostOfInstalledApplications": 34442.56,
  • "totalCost": 37882.55
}

Get computer logon histories

Returns a collection of computer logon histories for a given computer and all users.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get user computer logon history

Returns a collection of computer logon histories for a given user and all computers.

Authorizations:
BearerAuth
path Parameters
userid
required
string

The unique ID of the user.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer user logon history

Returns the details of the logon history for a given computer and user.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer for which the details of the logon history will be returned.

userid
required
string

The unique ID of the user.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
  • "userId": "c9091484-a226-4b36-b1e1-250fe0757537",
  • "lastLogon": "2019-08-24T14:15:22Z",
  • "logonCount": 99
}

Get computers environment variables

Returns a collection of environment variables for all computers.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer environment variables

Returns a collection of environment variables for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Computers applications

Get computer applications

Returns a collection of applications for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computers applications

Returns a collection of applications for all computers.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer application

Returns the details of the application record for a given computer and application.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer for which the details of the application record will be returned.

applicationid
required
string

The unique ID of the application for which the details of the application record will be returned.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
  • "applicationId": "5be51be2-35ff-48f2-9214-00002248b242",
  • "bundleApplicationId": "023cab7b-ca79-465e-8695-765cf4b72931",
  • "firstDiscovered": "2019-08-24T14:15:22Z",
  • "firstUsed": "2019-08-24T14:15:22Z",
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "usedCount": 5,
  • "usedUser": 1,
  • "usedMinutes": 566,
  • "usedDays": 45,
  • "isInstalled": true,
  • "isOEM": true,
  • "isMSDN": true,
  • "isVirtual": true,
  • "isOverridden": true,
  • "packageGUID": "7945ae86-fc21-4fa4-bf83-0fa4564a7deb",
  • "isRecognized": true,
  • "isRegistry": true,
  • "averageUsedTime": "39 minutes"
}

Get computers application usage

Returns a collection of application usage data for all computers and all users.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get user computer application usage

Returns a collection of application usage data.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computers application usage summary

Returns a collection of application usage summaries.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Computers hardware

Get computer display adapters

Returns a collection of display adapters for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
  • "name": "Cindy's Display Adapter",
  • "currentResolution": "960 X 600",
  • "maxResolution": "1920 X 1080",
  • "isUpdated": true
}

Get computer hard drives

Returns a collection of hard drives for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer optical drives

Returns a collection of optical drives for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer hardware

Returns the details of the hardware for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer for which the details of the hardware will be returned.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
  • "processorCount": 2,
  • "coreCount": 1,
  • "processorType": "Intel Core i5",
  • "processorSpeed": 512,
  • "memorySlots": 4,
  • "memorySlotsAvailable": 1,
  • "physicalMemory": 512,
  • "systemDiskSpace": 500,
  • "systemDiskSpaceAvailable": 221,
  • "totalDiskSpace": 750,
  • "totalDiskSpaceAvailable": 275,
  • "totalDiskSpaceUsed": 502,
  • "socketCount": 8,
  • "isSocketCountManualOverrideEnabled": true,
  • "chipModulesPerProcessor": 2,
  • "processorManufacturer": "Intel",
  • "logicalProcessorCount": 2
}

Get computer logical disk

Returns a collection of logical disks for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer monitors

Returns a collection of monitors for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
  • "name": "Alex's monitor 1",
  • "maxResolution": "7690 X 4320",
  • "isUpdated": true
}

Get computers network adapters

Returns a collection of network adapters for all computers.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer network adapters

Returns a collection of network adapters for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer processors

Returns a collection of processors for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get socket map

Returns the details of the socket map for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer for which the details of the socket map will be returned.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "15764003-3c61-4d5f-9839-a63271240519",
  • "manufacturer": "TE Connectivity",
  • "model": "LGA-456",
  • "socketCount": 2
}

Get computer registries

Returns a collection of registries for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Computers metrics

Get computers metrics

Returns a collection of metric tracking data for all computers.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}

Get computer metrics

Returns a collection of metric tracking data for a given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
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

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "items": [
    ],
  • "pagination": {
    }
}