Computer

GET
computers
Fetches a list of computers.

Request: URL is all that is required. You can reduce the amount of information returned in the response using the ?fields= parameter, as described in Filtering Response Fields.

Response: List of computers and Last Report time.

Response Schema: BESAPI.xsd

GET
computer/{computer id}
Gets a computer's core properties.

Request: URL is all that is required. You can reduce the amount of information returned in the response using the ?fields= parameter, as described in Filtering Response Fields.

Response: Lists all of a computer's properties.

Response Schema: BESAPI.xsd

DELETE
computer/{computer id}
Marks a computer as deleted in the database.

Request: URL is all that is required.

GET
computer/{computer id}/settings
Gets a computer's settings.

Request: URL is all that is required.

Response: Lists client settings for a computer.

Response Schema: BESAPI.xsd

POST
computer/{computer id}/settings
Updates or creates the value of a setting.

Request: XML for setting.

Request Schema: BESAPI.xsd

Response Schema: BESAPI.xsd

DELETE
computer/{computer id}/settings
Deletes all activations for the specified analysis.

Request: URL is all that is required.

POST
computers/settings
Updates or creates settings for multiple computers.

Request: XML for setting.

Request Schema: BESAPI.xsd

Response Schema: BESAPI.xsd

GET
computer/{computer id}/setting/{setting name}
Gets the setting value.

Request: URL is all that is required.

Response: Returns setting value.

Response Schema: BESAPI.xsd

PUT
computer/{computer id}/setting/{setting name}
Updates the setting value.

Request: XML for setting.

Request Schema: BESAPI.xsd

Response Schema: BESAPI.xsd

POST
computer/{computer id}/setting/{setting name}
Updates or creates the setting value.

Request: XML for setting.

Request Schema: BESAPI.xsd

Response Schema: BESAPI.xsd

DELETE
computer/{computer id}/setting/{setting name}
Delete computer setting.

Request: URL is all that is required.

GET
computer/{computer id}/fixlets
Gets the list of relevant Fixlets.

Request: URL is all that is required.

Response: The list of relevant Fixlets and their ID.

Response Schema: BESAPI.xsd

GET
computer/{computer id}/tasks
Gets the list of relevant tasks.

Request: URL is all that is required.

Response: List of relevant tasks and their ID.

Response Schema: BESAPI.xsd

GET
computer/{computer id}/mailbox
Gets contents of the computer's mailbox

Request: URL is all that is required.

Response Schema: BESAPI.xsd

Filtering Response Fields

You can use the ?fields= parameter to limit the fields returned for a given resource when using the API resources /api/computers and /api/computer/{computer id}. The value following the ?fields= parameter is the filter. Because the XML is case sensitive, ensure that you specify the correct case to avoid errors.

Use these characters to define the filter:

  • , to separate elements, children, and attribute pairs
  • , within the parenthesis to denote multiple children
  • &as pairing marker for attributes
  • <...> to denote attributes
  • = to mark LHS and RHS of attributes

These are some example of filtering results using ?fields=:

/api/computer/1234?fields=Property<Name=Computer%20Name,OS,Last%20Report%20Time>
/api/computer/1234?fields=Property<Analysis&Name=Analysis1&Computer%20Name,&OS,Analysis2&Last%20Report%20Time>