Admin

GET
/api/admin/fields
Returns the list of admin fields.

Request: URL is all that is required

For example: https://server.bigfix.com:52311/api/admin/fields

Response: XML results.

For example: 

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <AdminField Resource="http://server.bigfix.com:52311/api/admin/field/usePre70ClientCompatibleMIME">
        <Name>usePre70ClientCompatibleMIME</Name>
        <Value>false</Value>
    </AdminField>
</BESAPI>

Response Schema: BESAPI.xsd

POST
/api/admin/fields
Sets one or more admin fields.

Request: One or more admin fields in a XML document.

For example:

Request Schema: BESAPI.xsd

Response: Details of all the admin fields after update..

Response Schema: BESAPI.xsd

GET
/api/admin/field/{field}
Fetches specific admin field value.

Request: URL is all that is required

For example: https://server.bigfix.com:52311/api/admin/field/usePre70ClientCompatibleMIME

Response: XML results

For example:

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <AdminField Resource="http://server.bigfix.com:52311/api/admin/field/usePre70ClientCompatibleMIME">
        <Name>usePre70ClientCompatibleMIME</Name>
        <Value>false</Value>
    </AdminField>
</BESAPI>

Response Schema: BESAPI.xsd

PUT
/api/admin/field/{field}
Sets a specific admin field.

Request: Send an XML with the admin field value.

Request Schema: BESAPI.xsd

Response: Details of the admin field after update.

Response Schema: BESAPI.xsd

POST
/api/admin/field/{field}
Sets a specific admin field.

Request: Send an XML with the admin field value.

Request Schema: BESAPI.xsd

Response: Details of the admin field after update.

Response Schema: BESAPI.xsd

DELETE
/api/admin/field/{field}
Deletes the specific admin field.

Request: Send XML with the admin field value.

For example: https://server.bigfix.com:52311/api/admin/field/usePre70ClientCompatibleMIME

Request Schema: BESAPI.xsd

Response: Details of the admin field after update.

Response Schema: BESAPI.xsd

GET
/api/admin/masthead
Exports the current masthead.

Response: Masthead file.

POST
/api/admin/masthead
Updates the masthead in the database.

Request: Masthead file in post body

Response: Details of the admin field after update. You will get HTTP 200 upon success.

Notes: If FIPS setting is changed, the server will need to be restarted.

GET
/api/admin/masthead/parameters
Returns the list of the masthead configuration parameters and values.

Response: XML results.

For example:

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <MastheadParameters Resource="http://server.bigfix.com:52311/api/admin/masthead/parameters">
        <PortNumber>52311</PortNumber>
        <GatherInterval>Half Day</GatherInterval>
        <Controller>console</Controller>
        <InitialLockState>Unlocked</InitialLockState>
        <RequireFIPSCompliantCrypto>false</RequireFIPSCompliantCrypto>
    </MastheadParameters>
</BESAPI>

Response schema: BESAPI.xsd.

GET
/api/admin/icon
Exports the current client icon.

Response: Icon file.

Content type: image/bmp

PUT
/api/admin/icon
Updates/sets client icon.

Request: Icon in POST body.

Response: HTTP 200 upon success.

POST
/api/admin/icon
Updates/sets client icon.

Request: Icon in POST body.

Response: HTTP 200 upon success.

DELETE
/api/admin/icon
Deletes current client icon.
POST
/api/admin/propagate/operator/{operator}
Propagates the specified operator site.

Request: URL Only.

Response: HTTP 200 upon success.

POST
/api/admin/propagate/actionsite
Propagates the master action site.

Request: URL Only.

Response: HTTP 200 upon success.

POST
/api/admin/propagate/operators
Propagates all operator sites.

Request: URL Only.

Response: HTTP 200 upon success.

POST
/api/admin/propagate/resetepoch
Resets the database epoch forcing Console's to refresh their cache.

Request: URL Only.

Response: HTTP 200 upon success.

GET
/api/admin/options
Displays the current admin options for the server.

Request: URL Only.

Response: HTTP 200, BESAPI XML of admin options.

For example:

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <SystemOptions Resource="http://server.bigfix.com:52311/api/admin/options">
        <MinimumRefreshSeconds>15</MinimumRefreshSeconds>
        <DefaultFixletVisibility>Visible</DefaultFixletVisibility>
    </SystemOptions>
</BESAPI>
POST
/api/admin/options
Updates the admin options from the provided BESAPI XML.

Request: BESAPI representation of 1 or more admin options.

Response: HTTP 200 on success, BESAPI XML of admin options.

For example: 

<?xml version="1.0" encoding="UTF-8"?>
<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
    <ClientReports Resource="http://server.bigfix.com:52311/api/admin/reports">
        <EncryptionStatus>Disabled</EncryptionStatus>
        <Details>Report encryption is currently DISABLED.</Details>
    </ClientReports>
</BESAPI>

Response schema: BESAPI.xsd

GET
/api/admin/reports
Returns the client report settings.

Request: BESAPI XML of settings.

Response: BESAPI.xsd

GET
/api/admin/reports/cert
Returns the server certificate.

Response: Certificate in PEM format.

GET
/api/admin/reports/key
Returns the server certificate.

Response: Certificate in PEM format.