Solace DocsDeveloper HubSolace Community
API Reference

Get a list of EMAs

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

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

Token Permissions: [ event_management_agent:read ]

Query Params
int32
1 to 100
Defaults to 20

The number of EMAs 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 EMAs.

ids
string

Match only EMAs created by this user

string

Match only EMAs in the given EMA-Region

string
deprecated

Specify extra data to be included, options are: referencedByMessagingServiceIds.

Replacement: Use expand instead.

Reason: The change is to align with the API specification design.

Removal Date: 2024-11-03 18:00:00.000.

string

Specify extra data to be included, options are: referencedByMessagingServiceIds.

Responses

Updated 12 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 12 months ago