Input Data Format

The data format for sending requests to the Bacula REST server is a URL encoded format compatible with the common URLs that are used by the HTTPS protocol.

https://<host>/<category>/<class>[/subclass/...]?option=value[&...]

where:

<host>

is the host name

<category>

is one of the following:

cat: for catalog data. The class is the name of the catalog SQL table concerned. Upper/lower case is important.
res: for resource data. The class is the name of the resource concerned. Upper/lower case is ignored.
status: for status information. Status has no class.
cmd: for bconsole commands.
conf: for configure resources.

<class>

is the class or type of object desired.

<subclass>

is an additional specification of the class. At the current time, no subclass is implemented, but it is planned in a future release.

<option>

is a keyword that selects or limits the object class (see tables below). The option is specific to the class specified.

<value>

is the value associated with the keyword. Not all keywords have values.

To specify a particular Bacula component (Director, Client, Storage), use option=value, where the option is: director, client, storage, console, bat, and the value is the name of the component. If no component name is given, then the default director is assumed.

A concrete example of input that would obtain a list of all the Client objects from the Bacula catalog would be:

https://localhost/cat/Client