Search Query Syntax

Lists of resources may be searched/filtered using the optional q (query) parameter. The search query uses a simple syntax:

  • Search terms must be in the form field:query
    • Valid values for field depend on the resource type, e.g. for assets you may search the filename field
    • query is the search string. A wildcard * may be used to match any sequence of zero or more characters. The search string may optionally be quoted.
    • The search term may optionally be preceded by a bang ! to negate the filter
    • Some examples of valid search terms:
    • name:foo search for an exact match
    • name:*f* search for any resource with “f” in the name
    • name:"My Resource" search for an exact match
    • !name:"My *" search for any resource that does not start with “My “
  • Multiple search terms may be applied using the AND operator
    • Only resources that match ALL the terms will be included in the response
    • e.g. type:implicit/evaluate AND state:success search for successful implicit/evaluate jobs only

OR operator and grouping of search terms not currently supported. Support for searching numeric and date time ranges is planned.