Sign in
Message Brokers

List Message Brokers

Retrieves a paginated list of message brokers.

get/api/v1/message-brokers

Query parameters

filter[name]string

Filter results by name.

filter[description]string

Filter results by description.

filter[host]string

Filter results by host.

filter[protocol]string

Filter results by protocol.

filter[auth_type]string

Filter results by auth_type.

filter[port]string

Filter results by port.

includestring

Comma-separated list of relationships to include. Available: flows, messageBrokerQueues, variables, flowMessageBrokerQueues

sortstring

Sort field. Prefix with - for descending. Available: name, description, host, port, protocol, auth_type

pageinteger

Page number for pagination.

per_pageinteger

Number of results per page.

Response

Successful response

Changes

No recorded changes to this endpoint across all 1 revision of this API.