Skip to content

Latest commit

 

History

History
70 lines (55 loc) · 2.96 KB

File metadata and controls

70 lines (55 loc) · 2.96 KB
title Stream Connections
sidebarTitle Introduction
description The Stream Connections endpoints let you retrieve the history of your application's streaming connections and terminate active or. Enterprise X API v2 tier.
keywords
stream connections
connection history
terminate connections
manage streaming
disconnect streams
streaming API connections

The Stream Connections endpoints let you retrieve the history of your application's streaming connections and terminate active or multiple connections. Use these to monitor connection status, resolve issues like duplicate connections, and manage streaming sessions for endpoints like Filtered Stream and Sampled Stream.

These endpoints require [Bearer Token authentication](/fundamentals/authentication/oauth-2-0/application-only) and are available for apps with access to streaming endpoints.

Overview

View active and past connections End all active streaming connections Stop connections for specific streams Kill specific connections by UUID

Endpoints

Method Endpoint Description
GET /2/connections Get active and historical streaming connections
DELETE /2/connections/all Terminate all active connections
DELETE /2/connections/{endpoint_id} Terminate connections for a specific endpoint
DELETE /2/connections Terminate multiple connections by UUIDs

Use cases

  • Troubleshoot disconnections — Check history to diagnose issues (see handling disconnections)
  • Enforce connection limits — Terminate duplicate or excess connections
  • Clean up sessions — Stop all streams before maintenance or redeploy
  • Monitor usage — Track connection patterns across endpoints like filtered_stream, sample_stream

Getting started

**Prerequisites** Full endpoint documentation Learn about streaming