Retrieval of clusters

You use the GET operation on the api/sam/clusters element to request information about clusters that group your host computer systems. This information represents the current state of your environment and does not include any historical data.

After you retrieve the IDs of your clusters, compare them with the cluster_id column retrieved by API for computer systems to recognize which of these systems belong to which clusters. This information can also be viewed on the Hardware Inventory report in the user interface.

To retrieve information about clusters, use the following URL: 
https://hostname:port/api/sam/clusters?token=token
Important:
  • To use this API, you must be assigned to the All Computers group and have the View Hardware Inventory permission.
  • Each API request must be authenticated with the token parameter. You can retrieve it by using REST API for retrieving authentication token. You can also log in to BigFix Inventory, hover over the User icon User icon, and click Profile. Then, click Show token.
  • By default, the retrieved data is sorted by id.
Table 1. Operation descriptions
Operation details Description
Operation GET /api/sam/clusters
Purpose Returns a list of clusters.
HTTP method GET
Resource URI https://server_host_name:port_number/api/sam/clusters
URL link relation n/a
URI query parameters For a list of applicable query parameters, see: Query parameters.
Request headers
Header
Accept-Language (optional)
Values
en-US (only English is supported)

Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
Request payload n/a
Request Content-Type
  • application/json
Response headers
Header
Content-Type
Values
application/json

Specifies the content type of the response.
Header
Content-Language
Values
en-US, …

Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
Header
Import-Mode
Values
none, idle, running, pending

Specifies the data import status.
Header
Import-Progress
Values
A percentage value, for example 59.

Specifies the percentage progress of a data import.
Header
Import-Last-Status
Values
successful, failed

Specifies the status of the last data import.
Header
Import-Last-Success-Time
Values
Date, for example 2014-06-18T04:00:29Z.

Specifies the time of the last successful data import.
Response payload Clusters element
Response Content-Type
  • application/json
Normal HTTP response codes
  • 200 – OK
Error HTTP response codes
  • 500 – "Bad Request" if a query parameter contains errors or is missing

Message body includes an error message with details.

Query parameters

You can use query parameters to narrow down the results of your search. The following table presents query parameters that you can use for the api/sam/clusters element.
Table 2. Query parameters for retrieving clusters
Parameter Description Required Value
columns Specify which columns to retrieve. If you do not specify this parameter, a set of default columns is retrieved. For available columns, see Response body. Example:
Retrieve the name and id columns:
URL?columns[]=name&columns[]=id
 No String
order Specify how to sort the returned data. The default direction for sorting columns is ascending. If you want to specify a descending sort, append desc to the column name. Example:
Order by type descending:
URL?order[]=type desc
 No String
limit Specify the number of rows to retrieve. If you omit this parameter, all rows are retrieved. No Numeric
offset Specify the number of rows to skip for retrieving results. You can use it together with the limit parameter to paginate results. Example:
Retrieve 50 records starting after record 150:
URL?limit=50&offset=150
 No Numeric
token A unique user authentication identifier. You can view your token in the Profile preferences of BigFix Inventory. Yes Alphanumeric

Example HTTP conversation

Request
GET api/sam/clusters
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Response header
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
The above response header may be followed by different entries, depending on the current status of the data import which is represented by Import-Mode. To understand the returned values, see the following definitions:
  • none - a data import has never been initiated
  • idle - no data imports are currently running
  • running - a data import is in progress
  • pending - an action performed in the user interface requires a data import to be started for the change to take effect
If a data import has never been initiated:
Import-Mode: none
If a data import is in progress:
Import-Mode: running
Import-Progress: 41
If a data import is not running:
Import-Mode: idle/pending
Import-Last-Status: successful
Import-Last-Success-Time: Mon, 23 Jun 2014 12:18:29 GMT
Response body (JSON)
{	
 "id": 1,
 "name": "Production Cluster 1",
 "cores_count": 24,
 "vm_manager_url": "https://198.51.100/sdk",
}
Example about adding a vm_manager_status column to the result
API: /api/sam/clusters?columns[]=name&columns[]=cores_count&columns[]=vm_manager_url&columns[]=vm_manager_status
Response:
{
 {
   { 
     "id": 1,
     "name":
     "Production Cluster 1",
     "cores_count": 24, 
     "vm_manager_url":
     "https://198.51.100/sdk",
     "vm_manager_status": "98"
   }
 }
}
Example about filtering out data from inactive VM Managers
API: api/sam/clusters?criteria=\
{
 "and":
  [
    [
      "vm_manager_status","!=","98"
    ]
   ]
}

For description of other VM Managers statuses, see Retrieval of VM managers.