Solace DocsDeveloper HubSolace Community
API Reference

Get a list of messaging services

get
https://api.solace.cloud/api/v2/architecture/messagingServices

Use this API to get a list of messaging services that match the given parameters.

Token Permissions: [ event_designer:access ]

Query Params
int32
1 to 100
Defaults to 20

The number of messaging services to get per page.

int32
≥ 1
Defaults to 1

The page number to get.

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.

ids
array of strings

The IDs of the messaging services.

ids
string

Match only messaging services of the given type, options are: solace, kafka.

string

Match only messaging services in the given runtimeAgentId

string

Match only messaging services in the given eventMeshId

string
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
Updated 11 months ago