Skip to main content

Computers

API docs by Redocly

SAM: Computers (1.0.0)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with computers.

Computer application metering

Get application metering

Returns a collection of metric tracking data for computer applications.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 application metering by computer

Returns a collection of metric tracking data for applications on the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer applications

Get computer's applications

Returns a collection of applications for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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's details

Returns the details of the given computer application.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

applicationid
required
string

The unique ID of the application.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "c1d617ff-2104-411c-9c20-682017a9fefd",
  • "applicationId": "c1d617ff-2104-411c-9c20-682017a9fefd",
  • "bundleApplicationId": "c1d617ff-2104-411c-9c20-682017a9fefd",
  • "firstDiscovered": "2024-03-24T12:52:20Z",
  • "firstUsed": "2024-03-24T12:52:20Z",
  • "lastUsed": "2024-03-24T12:52:20Z",
  • "usedCount": 10,
  • "usedUser": 10,
  • "usedMinutes": 10,
  • "usedDays": 10,
  • "isInstalled": true,
  • "isOEM": true,
  • "isMSDN": true,
  • "isVirtual": true,
  • "isOverridden": true,
  • "packageGUID": "640b16bb-447f-430f-87ee-49bfe940e308",
  • "isRecognized": true,
  • "isRegistry": true,
  • "averageUsedTime": "2024-03-24T12:52:20Z",
  • "unbundled": true
}

Get computer applications

Returns a collection of applications.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 application usage data

Returns a collection of application usage data.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 application user usage

Returns a collection of users' application usage data.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 application usage summaries

Returns a collection of application usage summaries.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer contracts

Get computer's contracts

Returns a collection of contracts for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer costs

Get computer's costs

Returns the details of a computer's costs.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "4f2403da-3ab5-48f8-9114-73304cfeb017",
  • "vendor": "Dell Inc.",
  • "purchaseDate": "2024-03-24T12:52:20Z",
  • "purchasePrice": 2521.32,
  • "purchaseValueBase": 2500.32,
  • "purchaseCurrency": "EUR",
  • "invoiceReference": "2024/03/63729P",
  • "totalCostOfInstalledApplications": 1452.28,
  • "totalCost": 3973.6
}

Computer display adapter

Get computer's display adapters

Returns a collection of display adapters for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": "66a6b2b7-2ff1-403f-add3-60ed14a0233a",
  • "name": "NVIDIA T1200 Laptop GPU",
  • "currentResolution": "1920 x 1200",
  • "maxResolution": "2560x1440",
  • "isUpdated": true
}

Computer drives

Get computer's drives

Returns a collection of hard drives for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer environment variables

Get computer's environment variables

Returns a collection of environment variable for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 computer environment variables.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer hardware

Get computer's hardware details

Returns the details of the hardware for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "990b4de8-f11f-4904-9e86-d8a435835574",
  • "processorCount": 2,
  • "coreCount": 8,
  • "processorType": "11th Gen Intel Core i7-1185G7 @ 3.00GHz (3.00 GHz)",
  • "processorSpeed": 2995,
  • "memorySlots": 8,
  • "memorySlotsAvailable": 2,
  • "physicalMemory": 16384,
  • "systemDiskSpace": 957534,
  • "systemDiskSpaceAvailable": 552150,
  • "totalDiskSpace": 957534,
  • "totalDiskSpaceAvailable": 552150,
  • "totalDiskSpaceUsed": 405384,
  • "socketCount": 2,
  • "isSocketCountManualOverrideEnabled": true,
  • "chipModulesPerProcessor": 2,
  • "processorManufacturer": "Intel",
  • "logicalProcessorCount": 12
}

Computer logical disks

Get computer's logical disks

Returns a collection of logical disks for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer logon history

Get computer's logon history

Returns a collection of logon history for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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's logon history on all computers

Returns a collection of computer logon histories for the given user.

Authorizations:
BearerAuth
path Parameters
userid
required
string

The unique ID of the user.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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's logon history on a computer

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

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

userid
required
string

The unique ID of the user.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "0d779524-e2cf-4636-a701-65ce7c3f5763",
  • "userId": "c5a87d81-b035-4b38-88f8-13fabd790764",
  • "lastLogon": "2024-03-24T12:52:20Z",
  • "logonCount": 10
}

Computer monitors

Get computer's monitors

Returns a collection of monitors for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": "636d9b38-1afd-4b96-8998-01d475cc0f36",
  • "name": "Intel UHD Graphics",
  • "maxResolution": "2560 x 1600",
  • "isUpdated": true
}

Computer network adapters

Get computer's network adapters

Returns a collection of network adapters for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 all network adapters

Returns a collection of network adapters.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer processors

Get computer's processors

Returns a collection of processors for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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 processor socket details

Returns the details of the processor sockets for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "computerId": "cf5be788-06be-4496-91b0-bfaa8c239e96",
  • "manufacturer": "Intel",
  • "model": "LGA 1151",
  • "socketCount": 2
}

Computer registries

Get computer's registries

Returns a collection of registries for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer remote clients

Get computer's remote clients

Returns a collection of remote clients for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Computer virtual machines

Get computer's virtual machines

Returns a collection of virtual machines for the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the virtual machine.

query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 100

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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

Get computer details

Returns the details of the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "5043cc04-3ef2-4882-a3be-8d08b4f402c7",
  • "scanIdentifier": "MAC-C02GD9DUML7H",
  • "hostName": "AM21-S42MONITOR",
  • "domain": "APAC",
  • "lastScanDate": "2024-03-24T12:52:20Z",
  • "biosSerialNumber": "43-01-10-TX",
  • "biosVersion": "1.26.0",
  • "biosDate": "2024-03-24T12:52:20Z",
  • "manufacturer": "Lenovo",
  • "manufacturerWebsite": "https://www.lenovo.com",
  • "model": "T480s",
  • "isPortable": true,
  • "infoTransferDate": "2024-03-24T12:52:20Z",
  • "clientInstallDate": "2024-03-24T12:52:20Z",
  • "clientVersion": "6.14.3",
  • "clientSiteName": "snow",
  • "clientConfigurationName": "SnowAtlas",
  • "scannerVersion": "7.0.0",
  • "quarantineDate": "2024-03-24T12:52:20Z",
  • "isQuarantineManagementDisabled": true,
  • "operatingSystem": "Microsoft Windows 11 Pro",
  • "operatingSystemId": "c27c14a7-dcec-4f8e-b08e-cdb7263b5378",
  • "operatingSystemServicePack": "SP1",
  • "operatingSystemSerialNumber": "V6E3X-S6J5H-L5F5P-M4M2Y",
  • "ipAddress": "10.20.20.77",
  • "isVirtual": true,
  • "hostComputerId": "037e6448-6ad3-4279-800d-010677485bbb",
  • "siblingComputerId": "687e2c50-6900-463a-b470-8c12e3677be8",
  • "isUpdated": true,
  • "is64bit": true,
  • "isServer": true,
  • "hypervisorName": "VMware Virtual Platform",
  • "isVdi": true,
  • "processorValueUnit": 32,
  • "reportingDate": "2024-03-24T12:52:20Z",
  • "architecture": "64-bit",
  • "organizationId": "293cf227-bf7f-4919-b664-791f3f49e1ef",
  • "status": "Active",
  • "isAutoEditingDisabled": true,
  • "purchaseDate": "2024-03-24T12:52:20Z",
  • "purchaseValue": 2461.32,
  • "purchaseCurrency": "EUR",
  • "purchaseValueBase": 2500.32,
  • "invoiceReference": "2024/03/63729P",
  • "notes": "Purchased in a set with printer",
  • "securityCode": "A563Z",
  • "updatedDate": "2024-03-24T12:52:20Z",
  • "isIncludedInWindowsServerRequirement": true,
  • "mostRecentUser": "77f8f11f-e4f8-4bed-8e44-b78d66244302",
  • "mostFrequentUser": "f2c35e21-aba4-4e0d-8c14-f3033e7b1fb7",
  • "vendor": "Dell Inc.",
  • "processorCount": 2,
  • "coreCount": 8
}

Delete computer

Removes the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Replace computer

Replaces the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Request Body schema: application/json
hostName
required
string non-empty

The host name of the computer.

hostComputerId
string or null <guid>

The unique ID of the host computer.

mostFrequentUser
string or null <guid>

The unique ID of the most frequent user of the computer.

mostRecentUser
string or null <guid>

The unique ID of the most recent user of the computer.

manufacturer
string or null

The manufacturer of the computer.

isPortable
boolean or null

true if the computer is portable; otherwise, false.

isVirtual
boolean or null

true if the computer is virtual; otherwise, false.

isServer
boolean or null

true if the computer is a server; otherwise, false.

model
string or null

The model of the computer.

operatingSystem
string or null

The operating system of the computer.

vendor
string or null

The vendor of the computer.

domain
string or null

The domain of the computer.

ipAddress
string or null

The IP address of the computer.

isVDI
boolean or null

true if the computer uses virtual desktop infrastructure; otherwise, false.

lastScanDate
required
string <date-time> non-empty

The last date that the computer was scanned.

status
required
string non-empty

The status of the computer.

organizationId
string or null <guid>

The unique ID of the organization to which the computer belongs.

processorCount
integer or null <int32>

The number of processors in the computer.

coreCount
integer or null <int32>

The number of cores in the computer.

Responses

Request samples

Content type
application/json
{
  • "hostName": "AM21-S42MONITOR",
  • "hostComputerId": "035613f6-26a5-4929-94f0-ed10a991438a",
  • "mostFrequentUser": "f2c35e21-aba4-4e0d-8c14-f3033e7b1fb7",
  • "mostRecentUser": "77f8f11f-e4f8-4bed-8e44-b78d66244302",
  • "manufacturer": "Lenovo",
  • "isPortable": true,
  • "isVirtual": true,
  • "isServer": true,
  • "model": "T480s",
  • "operatingSystem": "Microsoft Windows 11 Pro",
  • "vendor": "Dell Inc.",
  • "domain": "APAC",
  • "ipAddress": "10.20.20.77",
  • "isVDI": true,
  • "lastScanDate": "2024-03-24T12:52:20Z",
  • "status": "Active",
  • "organizationId": "293cf227-bf7f-4919-b664-791f3f49e1ef",
  • "processorCount": 2,
  • "coreCount": 8
}

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "5043cc04-3ef2-4882-a3be-8d08b4f402c7",
  • "scanIdentifier": "MAC-C02GD9DUML7H",
  • "hostName": "AM21-S42MONITOR",
  • "domain": "APAC",
  • "lastScanDate": "2024-03-24T12:52:20Z",
  • "biosSerialNumber": "43-01-10-TX",
  • "biosVersion": "1.26.0",
  • "biosDate": "2024-03-24T12:52:20Z",
  • "manufacturer": "Lenovo",
  • "manufacturerWebsite": "https://www.lenovo.com",
  • "model": "T480s",
  • "isPortable": true,
  • "infoTransferDate": "2024-03-24T12:52:20Z",
  • "clientInstallDate": "2024-03-24T12:52:20Z",
  • "clientVersion": "6.14.3",
  • "clientSiteName": "snow",
  • "clientConfigurationName": "SnowAtlas",
  • "scannerVersion": "7.0.0",
  • "quarantineDate": "2024-03-24T12:52:20Z",
  • "isQuarantineManagementDisabled": true,
  • "operatingSystem": "Microsoft Windows 11 Pro",
  • "operatingSystemId": "c27c14a7-dcec-4f8e-b08e-cdb7263b5378",
  • "operatingSystemServicePack": "SP1",
  • "operatingSystemSerialNumber": "V6E3X-S6J5H-L5F5P-M4M2Y",
  • "ipAddress": "10.20.20.77",
  • "isVirtual": true,
  • "hostComputerId": "037e6448-6ad3-4279-800d-010677485bbb",
  • "siblingComputerId": "687e2c50-6900-463a-b470-8c12e3677be8",
  • "isUpdated": true,
  • "is64bit": true,
  • "isServer": true,
  • "hypervisorName": "VMware Virtual Platform",
  • "isVdi": true,
  • "processorValueUnit": 32,
  • "reportingDate": "2024-03-24T12:52:20Z",
  • "architecture": "64-bit",
  • "organizationId": "293cf227-bf7f-4919-b664-791f3f49e1ef",
  • "status": "Active",
  • "isAutoEditingDisabled": true,
  • "purchaseDate": "2024-03-24T12:52:20Z",
  • "purchaseValue": 2461.32,
  • "purchaseCurrency": "EUR",
  • "purchaseValueBase": 2500.32,
  • "invoiceReference": "2024/03/63729P",
  • "notes": "Purchased in a set with printer",
  • "securityCode": "A563Z",
  • "updatedDate": "2024-03-24T12:52:20Z",
  • "isIncludedInWindowsServerRequirement": true,
  • "mostRecentUser": "77f8f11f-e4f8-4bed-8e44-b78d66244302",
  • "mostFrequentUser": "f2c35e21-aba4-4e0d-8c14-f3033e7b1fb7",
  • "vendor": "Dell Inc.",
  • "processorCount": 2,
  • "coreCount": 8
}

Get computers

Returns a collection of computers.

Authorizations:
BearerAuth
query Parameters
page_number
integer >= 1
Default: 1

The page number.

page_size
integer >= 1
Default: 25

The maximum number of items in the response.

filter
string

The fields which you can use to filter the results. Format of the query string parameter:

?filter=<filter name> <operator> <value>
Filter name Description Data type Example

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": {
    }
}

Bulk delete computers

Removes a collection of computers.

Authorizations:
BearerAuth
Request Body schema: application/json
filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

scope
required
string
Enum Description
Only

The operation is performed only on the computers whose IDs are specified.

All

The operation is performed on all computers.

AllExcept

The operation is performed on every computer except those whose IDs are specified.

The scope of the delete operation.

ids
Array of strings

The IDs that the operation is performed on.

Responses

Request samples

Content type
application/json
{
  • "filter": "name -eq Rover",
  • "scope": "All",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "successCount": 10,
  • "failedCount": 2,
  • "failed": {
    },
  • "failureReason": "These computers failed for reasons x and y."
}

Update computer

Modifies the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Request Body schema: application/json-patch+json
Array
One of
path
required
string

A JSON Pointer path.

value
required
any

The value to add, replace, or test.

op
required
string
Enum Description
add

Adds a value to an object or inserts it into an array.

replace

Replaces a value.

test

Tests that the specified value is set in the document.

The operation to perform.

Responses

Request samples

Content type
application/json-patch+json
{
  • "0": {
    }
}

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "5043cc04-3ef2-4882-a3be-8d08b4f402c7",
  • "scanIdentifier": "MAC-C02GD9DUML7H",
  • "hostName": "AM21-S42MONITOR",
  • "domain": "APAC",
  • "lastScanDate": "2024-03-24T12:52:20Z",
  • "biosSerialNumber": "43-01-10-TX",
  • "biosVersion": "1.26.0",
  • "biosDate": "2024-03-24T12:52:20Z",
  • "manufacturer": "Lenovo",
  • "manufacturerWebsite": "https://www.lenovo.com",
  • "model": "T480s",
  • "isPortable": true,
  • "infoTransferDate": "2024-03-24T12:52:20Z",
  • "clientInstallDate": "2024-03-24T12:52:20Z",
  • "clientVersion": "6.14.3",
  • "clientSiteName": "snow",
  • "clientConfigurationName": "SnowAtlas",
  • "scannerVersion": "7.0.0",
  • "quarantineDate": "2024-03-24T12:52:20Z",
  • "isQuarantineManagementDisabled": true,
  • "operatingSystem": "Microsoft Windows 11 Pro",
  • "operatingSystemId": "c27c14a7-dcec-4f8e-b08e-cdb7263b5378",
  • "operatingSystemServicePack": "SP1",
  • "operatingSystemSerialNumber": "V6E3X-S6J5H-L5F5P-M4M2Y",
  • "ipAddress": "10.20.20.77",
  • "isVirtual": true,
  • "hostComputerId": "037e6448-6ad3-4279-800d-010677485bbb",
  • "siblingComputerId": "687e2c50-6900-463a-b470-8c12e3677be8",
  • "isUpdated": true,
  • "is64bit": true,
  • "isServer": true,
  • "hypervisorName": "VMware Virtual Platform",
  • "isVdi": true,
  • "processorValueUnit": 32,
  • "reportingDate": "2024-03-24T12:52:20Z",
  • "architecture": "64-bit",
  • "organizationId": "293cf227-bf7f-4919-b664-791f3f49e1ef",
  • "status": "Active",
  • "isAutoEditingDisabled": true,
  • "purchaseDate": "2024-03-24T12:52:20Z",
  • "purchaseValue": 2461.32,
  • "purchaseCurrency": "EUR",
  • "purchaseValueBase": 2500.32,
  • "invoiceReference": "2024/03/63729P",
  • "notes": "Purchased in a set with printer",
  • "securityCode": "A563Z",
  • "updatedDate": "2024-03-24T12:52:20Z",
  • "isIncludedInWindowsServerRequirement": true,
  • "mostRecentUser": "77f8f11f-e4f8-4bed-8e44-b78d66244302",
  • "mostFrequentUser": "f2c35e21-aba4-4e0d-8c14-f3033e7b1fb7",
  • "vendor": "Dell Inc.",
  • "processorCount": 2,
  • "coreCount": 8
}

Update computer

Modifies the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Request Body schema: application/json-patch+json
Array
One of
path
required
string

A JSON Pointer path.

value
required
any

The value to add, replace, or test.

op
required
string
Enum Description
add

Adds a value to an object or inserts it into an array.

replace

Replaces a value.

test

Tests that the specified value is set in the document.

The operation to perform.

Responses

Request samples

Content type
application/json-patch+json
{
  • "0": {
    }
}

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "5043cc04-3ef2-4882-a3be-8d08b4f402c7",
  • "scanIdentifier": "MAC-C02GD9DUML7H",
  • "hostName": "AM21-S42MONITOR",
  • "domain": "APAC",
  • "lastScanDate": "2024-03-24T12:52:20Z",
  • "biosSerialNumber": "43-01-10-TX",
  • "biosVersion": "1.26.0",
  • "biosDate": "2024-03-24T12:52:20Z",
  • "manufacturer": "Lenovo",
  • "manufacturerWebsite": "https://www.lenovo.com",
  • "model": "T480s",
  • "isPortable": true,
  • "infoTransferDate": "2024-03-24T12:52:20Z",
  • "clientInstallDate": "2024-03-24T12:52:20Z",
  • "clientVersion": "6.14.3",
  • "clientSiteName": "snow",
  • "clientConfigurationName": "SnowAtlas",
  • "scannerVersion": "7.0.0",
  • "quarantineDate": "2024-03-24T12:52:20Z",
  • "isQuarantineManagementDisabled": true,
  • "operatingSystem": "Microsoft Windows 11 Pro",
  • "operatingSystemId": "c27c14a7-dcec-4f8e-b08e-cdb7263b5378",
  • "operatingSystemServicePack": "SP1",
  • "operatingSystemSerialNumber": "V6E3X-S6J5H-L5F5P-M4M2Y",
  • "ipAddress": "10.20.20.77",
  • "isVirtual": true,
  • "hostComputerId": "037e6448-6ad3-4279-800d-010677485bbb",
  • "siblingComputerId": "687e2c50-6900-463a-b470-8c12e3677be8",
  • "isUpdated": true,
  • "is64bit": true,
  • "isServer": true,
  • "hypervisorName": "VMware Virtual Platform",
  • "isVdi": true,
  • "processorValueUnit": 32,
  • "reportingDate": "2024-03-24T12:52:20Z",
  • "architecture": "64-bit",
  • "organizationId": "293cf227-bf7f-4919-b664-791f3f49e1ef",
  • "status": "Active",
  • "isAutoEditingDisabled": true,
  • "purchaseDate": "2024-03-24T12:52:20Z",
  • "purchaseValue": 2461.32,
  • "purchaseCurrency": "EUR",
  • "purchaseValueBase": 2500.32,
  • "invoiceReference": "2024/03/63729P",
  • "notes": "Purchased in a set with printer",
  • "securityCode": "A563Z",
  • "updatedDate": "2024-03-24T12:52:20Z",
  • "isIncludedInWindowsServerRequirement": true,
  • "mostRecentUser": "77f8f11f-e4f8-4bed-8e44-b78d66244302",
  • "mostFrequentUser": "f2c35e21-aba4-4e0d-8c14-f3033e7b1fb7",
  • "vendor": "Dell Inc.",
  • "processorCount": 2,
  • "coreCount": 8
}

Update computer

Modifies the given computer.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the computer.

Request Body schema: application/json-patch+json
Array
One of
path
required
string

A JSON Pointer path.

value
required
any

The value to add, replace, or test.

op
required
string
Enum Description
add

Adds a value to an object or inserts it into an array.

replace

Replaces a value.

test

Tests that the specified value is set in the document.

The operation to perform.

Responses

Request samples

Content type
application/json-patch+json
{
  • "0": {
    }
}

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "5043cc04-3ef2-4882-a3be-8d08b4f402c7",
  • "scanIdentifier": "MAC-C02GD9DUML7H",
  • "hostName": "AM21-S42MONITOR",
  • "domain": "APAC",
  • "lastScanDate": "2024-03-24T12:52:20Z",
  • "biosSerialNumber": "43-01-10-TX",
  • "biosVersion": "1.26.0",
  • "biosDate": "2024-03-24T12:52:20Z",
  • "manufacturer": "Lenovo",
  • "manufacturerWebsite": "https://www.lenovo.com",
  • "model": "T480s",
  • "isPortable": true,
  • "infoTransferDate": "2024-03-24T12:52:20Z",
  • "clientInstallDate": "2024-03-24T12:52:20Z",
  • "clientVersion": "6.14.3",
  • "clientSiteName": "snow",
  • "clientConfigurationName": "SnowAtlas",
  • "scannerVersion": "7.0.0",
  • "quarantineDate": "2024-03-24T12:52:20Z",
  • "isQuarantineManagementDisabled": true,
  • "operatingSystem": "Microsoft Windows 11 Pro",
  • "operatingSystemId": "c27c14a7-dcec-4f8e-b08e-cdb7263b5378",
  • "operatingSystemServicePack": "SP1",
  • "operatingSystemSerialNumber": "V6E3X-S6J5H-L5F5P-M4M2Y",
  • "ipAddress": "10.20.20.77",
  • "isVirtual": true,
  • "hostComputerId": "037e6448-6ad3-4279-800d-010677485bbb",
  • "siblingComputerId": "687e2c50-6900-463a-b470-8c12e3677be8",
  • "isUpdated": true,
  • "is64bit": true,
  • "isServer": true,
  • "hypervisorName": "VMware Virtual Platform",
  • "isVdi": true,
  • "processorValueUnit": 32,
  • "reportingDate": "2024-03-24T12:52:20Z",
  • "architecture": "64-bit",
  • "organizationId": "293cf227-bf7f-4919-b664-791f3f49e1ef",
  • "status": "Active",
  • "isAutoEditingDisabled": true,
  • "purchaseDate": "2024-03-24T12:52:20Z",
  • "purchaseValue": 2461.32,
  • "purchaseCurrency": "EUR",
  • "purchaseValueBase": 2500.32,
  • "invoiceReference": "2024/03/63729P",
  • "notes": "Purchased in a set with printer",
  • "securityCode": "A563Z",
  • "updatedDate": "2024-03-24T12:52:20Z",
  • "isIncludedInWindowsServerRequirement": true,
  • "mostRecentUser": "77f8f11f-e4f8-4bed-8e44-b78d66244302",
  • "mostFrequentUser": "f2c35e21-aba4-4e0d-8c14-f3033e7b1fb7",
  • "vendor": "Dell Inc.",
  • "processorCount": 2,
  • "coreCount": 8
}

Bulk update computers

Modifies a collection of computers.

Authorizations:
BearerAuth
Request Body schema: application/json
filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

scope
required
string
Enum Description
Only

The operation is performed only on the computers whose IDs are specified.

All

The operation is performed on all computers.

AllExcept

The operation is performed on every computer except those whose IDs are specified.

The scope of the update operation.

ids
Array of strings

The IDs that the operation is performed on.

required
object (ComputerUpdate)

The update to be applied to all IDs.

status
required
string

Status of the computer.

Responses

Request samples

Content type
application/json
{
  • "filter": "name -eq Rover",
  • "scope": "All",
  • "ids": [
    ],
  • "body": {
    }
}

Response samples

Content type
application/json
{
  • "successCount": 10,
  • "failedCount": 2,
  • "failed": {
    },
  • "failureReason": "These computers failed for reasons x and y."
}