Solace DocsDeveloper HubSolace Community
API Reference

Get a list of queue configurations

get
https://api.solace.cloud/api/v2/architecture/designer/configuration/solaceQueues

Get a list of Solace event queue configurations for a consumer in an application.

Your token must have one of the permissions listed in the Token Permissions.


Token Permissions: [ event_designer:access ]

Query Params
int32
1 to 100
Defaults to 20

The number of Solace event queue configurations to return per page.

int32
≥ 1
Defaults to 1

The page number to retrieve.

eventBrokerIds
array of strings

The unique identifiers of the event brokers, separated by commas, to retrieve queue configurations from.

eventBrokerIds
ids
array of strings

The unique identifiers of the queue configurations to retrieve, separated by commas.

ids
entityIds
array of strings

The unique identifiers of designer entities, separated by commas, to retrieve queue configurations from.

entityIds
string

The sorting criteria for the returned results. You can sort the results by query parameter in ascending or descending order.
Define the sort order using the following string: fieldname:asc/desc where:

  • fieldname — The field name of the query parameter to sort by.
  • asc — Sort the selected field name in ascending order.
  • desc — Sort the selected field name in descending order.

If the direction is not specified, the default is ascending.

You can use multiple query parameters to refine the sorting order.

Headers
string
enum
Defaults to application/json;charset=UTF-8

Generated from available response content types

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json;charset=UTF-8
application/json
Updated 11 months ago