Solace DocsDeveloper HubSolace Community
API Reference

(Beta) Get a list of Micro-Integrations

get
https://api.solace.cloud/api/v2/integration/microIntegrations

Get a listing of Micro-Integrations that are available for the account (or organization). You can filter the list of Micro-Integrations matching on criteria such as the Micro-Integration's name, state, and associated event broker service

Token Permissions: [ micro_integrations:get:* ]

Query Params
string

The full or partial name of the Micro-Integration that you can use to filter the query results. For example, you can use:

  • IBM
  • Amazon
  • gcppubsub
  • a
ids
array of strings

The list of the unique identifiers of the Micro-Integrations that you can use to filter the query results. You can retrieve the query results for specific Micro-Integrations.

ids
environmentIds
array of strings

Filter the list of Micro-Integrations by environment unique identifiers.

environmentIds
string

The unique identifier of an event broker service to filter that you can use to filter the query results. You can get a list of the Micro-Integrations that are associated with a specific event broker service.

states
array of strings

The states of the Micro-Integration that you can filter the query results. You can filter the results using the following states:

  • notdeployed-A Micro-Integration starts in the Not Deployed state when it's first created. In the Not Deployed state, data does not flow between your external system and the event broker service.
  • deploying-A transient state that indicates that the Micro-Integration is in the process of being deployed.
  • running-In the Running state, data flows between your external system and the event broker service.
  • undeploying-A transient state that indicates that the Micro-Integration is in the process of being undeployed.
  • error-An error condition occurred with the Micro-Integration and recovery is not possible. The reasons for the errors are displayed in the error text.
states
microIntegrationTypes
array of strings

The name of the Micro-Integration types that you can filter the query results. For example, you can use:

  • IBM
  • AWS
  • gcppubsub
microIntegrationTypes
string

The direction specifies whether the Micro-Integration is a source or target that you can use to filter the query results. The directions are:

  • source-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.
  • target-A target Micro-Integration is where data flows from the external system through the Micro-Integration to the event broker service.
createdBy
array of strings

The unique identifier representing the user who created the Micro-Integration that you can use to filter the query results.

createdBy
boolean

Additional information relating to the latest deployment for the Micro-Integrations to include in the query results. A value of true specifies to include the additional informatino in query results.

integer
≥ 1
Defaults to 1

The page number to retrieve.

integer
1 to 100
Defaults to 100

The number of Micro-Integrations to return on page.

string

The sorting criteria for the list of Micro-Integrations.

You can use the following value formats for the sort order:

  • attributes-names
  • attributes-names:sort-order

Use the sort-order to sort the attributes using one of the following values:

  • asc-ascending order
  • desc-descending order

If you do not define a sort order, it will default to ascending order. These are support attribute names you can sort by:

  • name
  • brokerId
  • state

For example, if you want to sort the list of Micro-Integrations by name in ascending order, you can use: name:asc

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 1 year 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 over 1 year ago