Explorer

The BigFix Explorer is a BigFix Platform component designed to query database data through session relevance. BigFix Explorer registers to a BigFix Server and offers near real-time data about the BigFix environment to BigFix Operators.

This family of REST APIs lets you interact with the BigFix Explorer servers to retrieve data and set the priority of each server.

GET
/api/explorers
Fetches a list of BigFix Explorer servers.

Request: URL is all that is required. By default, the information will be returned in XML format. If you need the information in JSON format, set the request header Accept: application/json or use the output=json parameter in the request URL to get a JSON response.

Response: An XML or a JSON text with a list of the BigFix Explorer servers connected to the BigFix Server, each represented with its own details.

The XML text contains a list of Explorer elements, one for each BigFix Explorer server. For each Explorer element:

  • the Resource attribute contains the REST API link to retrieve the details of the corresponding BigFix Explorer server (see /api/explorer/{name})
  • the URL element contains the URL of the corresponding server.

The JSON text contains a list named explorers with an entry object for each BigFix Explorer server. For each object:

  • the resource property contains the REST API link to retrieve the details of the corresponding BigFix Explorer server (see /api/explorer/{name})
  • the url property contains the URL of the corresponding server.

Response Schema: BESAPI.xsd

For example, this call:

https://server.bigfix.com:52311/api/explorers

May return this XML:

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <Explorer Resource="https://server.bigfix.com:52311/api/explorer/ddefefbe1a8b">
        <URL>https://explorer1.bigfix.com:9383</URL>
    </Explorer>
    <Explorer Resource="https://server.bigfix.com:52311/api/explorer/1a8b4decafbd">
        <URL>https://explorer2.bigfix.com:9383</URL>
    </Explorer>
</BESAPI>

Or this JSON, if the header Accept: application/json is set in the request or the output=json parameter is used in the request URL:

{
    "explorers":
    [
        {
            "url": "https://explorer1.bigfix.com:9383",
            "resource": "https://server.bigfix.com:52311/api/explorer/ddefefbe1a8b"
        },
        {
            "url": "https://explorer2.bigfix.com:9383",
            "resource": "https://server.bigfix.com:52311/api/explorer/1a8b4decafbd"
        }
    ]
}
GET
/api/explorer/{name}
Retrieves details about the Explorer server {name}.

Request: This API requires the unique {name} of a BigFix Explorer to be passed as part of the URL. The complete URL for this REST API request can be found in the Resource attribute of each Explorer node returned by the /api/explorers request. By default, the information will be returned in XML format. If you need the information in JSON format, set the request header Accept: application/json or use the output=json parameter in the request URL to get a JSON response.

Response: An XML containing a set of data regarding the specified Explorer server (URL, Name and Priority).

Response Schema: BESAPI.xsd

For example, this call:

https://server.bigfix.com:52311/api/explorer/ddefefbe1a8b

May return this XML:

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <ExplorerDetails>
        <Explorer>
            <URL>https://explorer1.bigfix.com</URL>
            <Name>ddefefbe1a8b</Name>
            <Priority>77</Priority>
        </Explorer>
    </ExplorerDetails>
</BESAPI>

Or this JSON, if the header Accept: application/json is set in the request or the output=json parameter is used in the request URL:

{
    "URL": "https://explorer1.bigfix.com:9383",
    "Name": "ddefefbe1a8b",
    "Priority": 77
}
PUT
/api/explorer/{name}
‚ÄčUpdates the priority of the BigFix Explorer server {name}.

Request: This API requires the unique {name} of a BigFix Explorer to be passed as part of the URL and an XML or JSON text describing the priority to assign to that server. The preferred BigFix Explorer server is the one with the highest priority value. The possible values to set for the priority are integers ranging from 0 to 255.

Response: In case of success, ok is returned.

Response Schema: BESAPI.xsd

The following example shows which steps to take to change the priority of the Explorer server named ddefefbe1a8b to 15.

First, prepare the XML that will be passed to the REST API:

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <ExplorerPriority>
        <Priority>15</Priority>
    </ExplorerPriority >
</BESAPI>

Save the XML to a file named, for example, priority.xml.

Then, from the terminal, run following command:

curl -X PUT --data-binary @priority.xml --user {username}:{password} https://server.bigfix.com:52311/api/explorer/ddefefbe1a8b

If the operation ran succesfully, the REST API will return this response:

ok

If you prefer using a JSON file as input, create a file named, for example, priority.json. The priority value must be an integer, do not quote it.

{ "Priority": 15 }

Then, from the terminal, run the following command (note that the Content-Type header is specified):

curl -X PUT --data-binary @priority.json --user {username}:{password} -H "Content-Type: application/json" https://server.bigfix.com:52311/api/explorer/ddefefbe1a8b

On success, the API will return:

ok