data.ServerConfigListResponse

Name Type
message string
serverCount integer
serversConfig [ data.ServerConfigTarget ]

data.ServerConfigResponse

Name Type
message string
serverConfig data.ServerConfigTarget

data.ServerConfigTarget

Name Type Description
description string Optional description of server.
disabled boolean Server disabled. When disabled, the server does not ingest any streams. Previously assigned streams may be migrated to other servers, depending on the load balancing configuration, and the availability of other servers.
hls_http_port integer Internal HLS port (for use by proxy).
hls_http_proxy_port integer HLS proxy port (for HLS stream access).
hls_secure boolean HTTPS enabled for HLS.
last_updated string Date and time the server configuration was last updated.
lb_participant boolean Participates in load balancing and failover operations. The server may be used to host streams ‘owned’ by other servers, in the event that those servers become disabled, unavailable, or overloaded.
multicast_ip_range string RTSP multicast IP range (CIDR).
multicast_rtcp_port integer Multicast RTCP port (for RTSP Multicast UDP stream access).
multicast_rtp_port integer Multicast RTP port (for RTSP Multicast UDP stream access).
name string Unique, alphanumeric server name or identifier. No spaces or special characters allowed (except for ‘-’ and ‘_’).
rtcp_port integer RTCP port (for RTSP UDP stream access).
rtmp_port integer RTMP port (for RTMP stream access).
rtmp_secure boolean RTMPS enabled (TLS encrypted RTMP).
rtmps_port integer RTMPS port (for RTMPS stream access).
rtp_port integer RTP port (for RTSP UDP stream access).
rtsp_multicast boolean RTSP multicast enabled.
rtsp_port integer RTSP port (for RTSP stream access).
rtsp_secure boolean RTSPS enabled (TLS encrypted RTSP).
rtsps_port integer RTSPS port (for RTSPS stream access).
se_api_host string IP address or hostname of server.
se_api_http_port integer Port for server (SE instance) API.
se_api_password string Password for server (SE instance) API.
se_api_secure boolean HTTPS enabled for server (SE instance) API.
se_api_user string Username for server (SE instance) API.
srt_port integer SRT port (for SRT stream access).
video_host string Video consumer facing IP address or hostname of server.
webrtc_http_port integer WebRTC HTTP port (for use by proxy).
webrtc_http_proxy_port integer WebRTC HTTP proxy port (for WebRTC stream requests / signalling).
webrtc_secure boolean HTTPS enabled for WebRTC.
webrtc_udp_port integer WebRTC UDP port (for WebRTC stream / video delivery).

data.ServerStatusListResponse

Name Type
message string
serverCount integer
serversStatus [ data.ServerStatus ]

data.ServerStatusResponse

Name Type
message string
serverStatus data.ServerStatus

data.ServerStatus

Name Type Description
cpu [ data.CpuInfo ] CPU information.
cpu_use number Instantaneous CPU utilization percent.
disk_total integer Total disk size in megabytes.
disk_used integer Disk space used in megabytes.
in_kbits integer Total network input rate in kilobits per second (5 second average).
load_fifteen number CPU utilization percent average over the last fifteen minutes.
load_five number CPU utilization percent average over the last five minutes.
load_memory number Memory utilization percent.
load_one number CPU utilization percent average over the last minute.
mem_cached integer Cached memory in megabytes.
mem_free integer Free memory in megabytes.
mem_shared_total integer Total shared memory in megabytes.
mem_shared_used integer Shared memory usage in megabytes.
mem_swapfree integer Free swap memory in megabytes.
mem_swaptotal integer Total swap memory in megabytes.
mem_total integer Total memory in megabytes.
mem_used integer Used memory in megabytes.
name string Unique, alphanumeric name or ID of server.
out_kbits integer Total network output rate in kilobits per second (5 second average).
speed integer Aggregate CPU speed in megahertz.
status string Status of server. Allowed values are “online”, “offline”, “unknown”, or “disabled”.
threads integer Number of CPU threads.
updatetime string Date and time the server status was last updated.

data.CpuInfo

Name Type Description
cores integer Number of CPU cores.
mhz number CPU speed in megahertz.
model string CPU model.
threads integer Number of CPU threads.

data.ServerStatusArchivedListResponse

| --- | --- |

data.ServerStatusArchived

| --- | --- | --- |