List Ingresses
Returns a list of all active ingresses, optionally filtered by room name.
Endpoint
GET /api/ingressRequest Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
roomName | string | No | Filter ingresses by room name |
Example Requests
List All Ingresses
curl -X GET https://live-api.block8910.com/api/ingress \
-H "x-api-key: YOUR_API_KEY"List by Room Name
curl -X GET "https://live-api.block8910.com/api/ingress?roomName=my-room" \
-H "x-api-key: YOUR_API_KEY"Response
{
"success": true,
"data": [
{
"ingressId": "IN_xxxxxxxxxxxxxx",
"name": "ingress-1234567890",
"streamKey": "aAXevUYwfj9K",
"url": "rtmp://rtmp.block8910.com:1935/x",
"rtmpUrl": "rtmp://rtmp.block8910.com:1935/x/aAXevUYwfj9K",
"roomName": "my-room",
"participantIdentity": "streamer-1",
"participantName": "My Stream",
"status": "ENDPOINT_INACTIVE",
"video": {
"width": 1920,
"height": 1080,
"framerate": 30
},
"enableTranscoding": true,
"createdAt": "2024-01-01T00:00:00.000Z"
}
]
}Response Fields
| Field | Description |
|---|---|
ingressId | Unique identifier for the ingress |
name | Name of the ingress |
streamKey | Stream key for RTMP authentication |
url | Base RTMP server URL |
rtmpUrl | Full RTMP URL for streaming |
roomName | Room name for viewers |
participantIdentity | Unique identifier for the streamer |
participantName | Display name of the streamer |
status | Current status of the ingress |
video | Video information (width, height, framerate) |
enableTranscoding | Whether transcoding is enabled |
createdAt | Timestamp when stream started |
Ingress States
| Status | Description |
|---|---|
ENDPOINT_INACTIVE | Ingress created but not streaming |
ENDPOINT_BUFFERING | Stream is buffering |
ENDPOINT_PUBLISHING | Actively streaming |
ENDPOINT_ERROR | Error occurred |