API Reference

(Early Access) Returns a list of all available Gateway Event Brokers

Returns a list of Gateway Event Brokers
This resource allows filtering of results by query using RSQL.

All fields of the MessagingService schema are queryable.

Log in to see full request history
Query Params
string
length between 5 and 1024

Query string for filtering entity. Expressed in FIQL/RSQL language.
This resource allows filtering of results by query using RSQL.
Examples:

  • ?where=brokerType==solace;state==RELEASED
  • ?where=(attributes.name==color;attributes.value==red)
    Notation:
  • Sub elements can be queried with dot notation, for example plan.name==Gold* matches all plans where the name starts with Gold. This also applies to querying nested arrays.
  • Queries on attributes where the name and the value must match specific criteria can be expressed by grouping the name and value search criteria.
    for example (attributes.name==color;attributes.value==Bl*) matches all objects where the value of attribute color starts with Bl such as Black or Blue. Queries on a combiation of attributes are also possible (attributes.name==color;attributes.value==Bl*);(attributes.name==flavour;attributes.value==*Berry) only matches documents where color starts with Bl and the flavour attribute ends in berry.

See https://github.com/jirutka/rsql-parser for details of the supported query operators and syntax

int32
1 to 100

The number of items to get per page. Min: 1 Max: 100

int32
1 to 16384

The page number to get. Min: 1

string
length between 2 and 512

name of a field to sort on, the sort direction parameter determines the order (asc/desc) of the sort

string

sort direction to be applied to the sort field name

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json