Parameters

The following parameters are required for each script that interrogates the datastore:

  • A valid query string as recognized by the datastore.
     See the Using-the-Query-Language for details of the syntax of datastore queries.

  • A valid user name and password.
     If you do not supply the correct credentials, the query fails.

    Note

    Unless you are using https, user names and passwords that are sent from a script are transmitted unencrypted.

  • The CSV API accepts an optional Boolean parameter enabling you to specify whether column headings are to be returned with CSV data. This parameter is ignored by the XML API.
    • To specify that headings are returned, use headings=1, the default.

    • To specify that headings are not returned, use headings=0.
       For example:

      http://appliance/ui/api/CsvApi?query=SEARCH%20Host&username=apiuser&password=password&headings=0

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*