Available endpoint parameters

List endpoints can take parameters to alter the data returned. These are:

  • rows - number of rows to return. Defaults to 50. If rows=0, then only a summary will be returned. If rows=all, all rows are returned.
  • page - page number to return. Defaults to 1
  • cols - which columns to return. This is a comma separated list. Only valid columns per object will be used. If no columns specified, will use all available columns for this object. Can prefix with a ”+” to add optional columns to the default list (Note: you may have URL encoding issues if run on the command line - use %2B to ensure that the symbol is passed to Opsview correctly). Can prefix column name with a ”-” to remove the column from the available list.
  • s.{columnname} - will search using LIKE for parameter. Add % for wildcards if required - this should be %25 to be encoded in the URL (see this article regarding URLs and encoded values). If parameter is specified multiple times, will be considered as an OR for that column. Can be repeated. If more than 1 column is specified, will consider to be an AND with other columns
  • s.{relation}.{columnname} - as above but it will search on related items. See hosts for an example
  • order - will sort the results based on the order specified. See below for more information
  • json_filter - this allows complex searching of fields. See below for more information
  • in_use - if set to 1, then each object will return in_use either 0 or 1 depending on if the object is being used by related objects

When parameters can be repeated (eg: s.{columnname}), this should be in the form