GET /2/connections

Returns active and historical streaming connections with disconnect reasons for the authenticated application.

Servers

Query parameters

Name Type Required Description
max_results Integer No

The maximum number of results to return per page.

Default value: 10

connection.fields[] Array No

A comma separated list of Connection fields to display.

status String No

Filter by connection status. Use 'active' for current connections, 'inactive' for historical/disconnected connections, or 'all' for both.

Valid values:

  • "inactive"
  • "active"
  • "all"

Default value: "active"

endpoints[] Array No

Filter by streaming endpoint. Specify one or more endpoint names to filter results.

pagination_token String No

Token for paginating through results. Use the value from 'next_token' in the previous response.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.