Using BigFix Explorer

BigFix Explorer REST APIs

BigFix Explorer REST API /api/relevance to evaluate a Session Relevance

This API, provided by the BES Explorer will evaluate the input Session Relevance. For more details about the usage of this API, refer to Session Relevance.

BigFix Explorer REST API /api/status to retrieve the current status of a BES Explorer instance

This API, provided by the BES Explorer will return the current status of a BES Explorer instance. For more details about the usage of this API, refer to Status.

BigFix Server REST APIs

/api/query API for Session Relevance

The REST API /api/query of the BigFix Root Server will be able to forward the input Session Relevance request to a BigFix Explorer instance if available. If no Explorer instance is available the BigFix Root Server will forward the request to a Web Reports instance.

A user can query the BigFix explorer using the existing REST API /api/query/. The api/query, described in Query, will support new input parameters for evaluating a Session relevance, maintaining the compatibility with the current specifications.

The BigFix Root Server will try forwarding first to the BigFix Explorer available with the highest priority, then will try with any Web Reports Server, according to their priority.

The new parameters allow the /api/query to exploit the /api/relevance features in order to submit requests in JSON format and to retrieve data from BigFix Explorer as customized structured JSON objects. For more details, refer to Query.

BigFix Explorer instances are targeted by priority and first connection time to the BigFix Root Server. Priority is assigned by the BigFix Root Server at registration time; the user can change the priority of an instance through API. If more than one explorer instance is available with same priority, the BigFix Root Server will forward to the one that registered first. Both Master operators and Non Master operators can issue a request to this rest API and the response content will be based on the visibility they have on the environment. The can use REST API privilege is required for BigFix Non-Master Operators.

New BigFix Server REST APIs to retrieve details and manage BES Explorer instances

This group of REST APIs, provided by the BigFix Root Server, lets the user retrieve data about BES Explorer instances registered to the BigFix Root Server, and interact with it to set the priority of each instance.

For more details about the usage of this group of APIs, refer to Explorer.