RESTAPI Fixlet

Note: For information about how to specify a site, see Hints about BigFix REST API requests.

GET
fixlets/{site type}/{site name}
Fetches a list of Fixlets of a particular site.
  • /api/fixlets/master --> returns fixlets from the master action site
  • /api/fixlets/custom/MyCustomSite --> returns fixlets from your MyCustomSite custom site.
  • /api/fixlets/external/BES Support --> returns fixlets from the external site "BES Support"
  • /api/fixlets/operator/Daniel --> returns fixlets from Daniel's operator site

Request: URL is all that is required

Response: BESAPI description of contained Fixlet resources.

Response Schema: BESAPI.xsd

POST
fixlets/{site type}/{site name}
Creates a fixlet in the specified site.

Request: Complete XML for the object in the body of the request

Request Schema: BES.xsd

Response Schema: BESAPI.xsd

GET
fixlet/{site type}/{site name}/{fixlet id}
Returns the details of the specified Fixlet.

Request: URL is all that is required

Response: XML of Fixlet

Response Schema: BES.xsd

PUT
fixlet/{site type}/{site name}/{fixlet id}
Updates a Fixlet.

Request: Complete XML for the object in the body of the request

Request Schema: BES.xsd

Response: Fixlet ID.

Response Schema: Plain text.

POST
fixlet/{site type}/{site name}
Creates a Fixlet in the specified site.

Request: Complete XML for the object in the body of the request

Request Schema: BES.xsd

Response Schema: BESAPI.xsd

Note: For backward compatibility, this action still accepts an id but ignore it even if referencing a non-existing object.

DELETE
fixlet/{site type}/{site name}/{fixlet id}
Deletes a Fixlet.

The same command applies to a task if you specify the task ID in place of the Fixlet ID.

Request: URL is all that is required

GET
fixlet/{site type}/{site name}/{fixlet id}/computers
Lists the computers that are relevant for this Fixlet.

Request: URL is all that is required

Response: XML list of computers.

Response Schema: BESAPI.xsd