Get Stream Details

'get_stream' will return the details for a specific stream in your cluster. You can supply either 'stream_guid' or 'hls_guid' to identify the correct stream.

curl -X POST "https://zeuscluster.com/api/?auth=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c=get_stream" \ 
    -d "stream_guid=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

curl -X POST "https://zeuscluster.com/api/?auth=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&c=get_stream" \ 
    -d "hs_guid=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

{
    "status": "success",
    "data": {
        "cluster_guid": "dfb2101b-3164-1385-2060-c720ac07e774",
        "stream_guid": "2af604b4-3166-c1a9-4de6-a7adf89b5458",
        "status": "online",
        "live_stream_last_updated": 1730763602,
        "is_banned": "no",
        "deleted": "no",
        "name": "Example Stream",
        "rtmp_guid": "bb72853c-060b-4938-9adf-2a53274ec642",
        "hls_guid": "cac3e1f1-b7a5-4cc8-8b40-890291afb718",
        "publisher_ip": "1.2.3.4",
        "ingress_server_guid": "58108a79-d9c0-fbaa-a30a-0463f73e1f40",
        "transcoder_server_guid": "42bbff07-a91a-88ea-129a-a86a089bb338",
        "record_stream": "yes",
        "stream_start_time": 1730449045,
        "is_high_risk": "no",
        "ai_monitor": "yes",
        "trigger_score": "0",
        "notes": "",
        "hls_stream": "https://watch.example.com/hls/cac3e1f1-b7a5-4cc8-8b40-890291afb718.m3u8",
        "transcoding_server": {
            "server_guid": "42bbff07-a91a-88ea-129a-a86a089bb338",
            "role": "2",
            "status": "online",
            "name": "Trans 01",
            "hostname": "trans-01.dev.us.example.com",
            "hostname_match": "yes",
            "ip_addresses": "[\"10.254.206.32\"]",
            "wan_ip_address": "1.2.3.4",
            "http_stream_port": 80,
            "uptime": 2426789,
            "connection_speed": 1000,
            "cpu_usage": "22.50",
            "ram_usage": "3.72",
            "disk_usage": "2.00",
            "bandwidth_down": "321",
            "bandwidth_up": "10",
            "lat": "",
            "lng": "",
            "country_code": "",
            "country_name": "",
            "region_name": "",
            "city": "",
            "zip_code": "",
            "time_zone": "",
            "os_version": "Ubuntu 24.04.1 LTS",
            "gpu_stats": "",
            "cpu_model": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
            "cpu_cores": "16",
            "cpu_speed": "2992.968",
            "ram_total": "32862924",
            "kernel": "6.8.0-45-generic",
            "active_connections": 12,
            "notes": null,
            "version": "3.0.0",
            "ffmpeg_active_streams": 0,
            "deleted": "no",
            "recording_storage_total": "639.09 TB",
            "recording_storage_free": "638.77 TB",
            "recording_storage_used": "332.76 GB"
        },
        "historical_streams": [
            {
                "stream_stats_guid": "ecbf8338-3418-5fb8-2ac4-9bfe9e2cd013",
                "stream_start_time": 1730432033,
                "stream_stop_time": 1730432152,
                "total_viewers": 0,
                "peak_viewers": 2,
                "trigger_score": 0,
                "video_codec": "h264",
                "video_resolution": "1080x1920",
                "video_bitrate": "2.7",
                "video_framerate": "60",
                "audio_codec": "aac",
                "audio_sample_rate": "48000",
                "audio_bitrate": "0.2",
                "recording_name": "bac3e1f1-b7a5-4cc8-8b40-890291afb718-1730432036.mp4",
                "recording_size": "37.17 MB",
                "recording_hls_guid": "bac3e1f1-b7a5-4cc8-8b40-890291afb718",
                "recording_timestamp": 1730432036,
                "recording_server_guid": "50bdd0f5-7f82-f0d8-cd0f-ab66e101f964",
                "mp4_stream": "https://watch.example.com/recording/ecbf8338-3418-5fb8-2ac4-9bfe9e2cd013",
                "mp4_download": "https://watch.example.com/recording/ecbf8338-3418-5fb8-2ac4-9bfe9e2cd013&download=yes"
            }
        ]
    }
}