LogoLogo
  • About
  • Installation
  • Update & migration
  • Configuration
    • Hostname
    • TLS / HTTPS
    • Database
    • Logging
    • API Security
    • Storage
      • Disk
      • In-memory
      • S3
    • RTMP
    • SRT
    • FFmpeg
    • Sessions
    • Metrics
    • Router
    • Debug
  • API Swagger-Documentation
  • API Clients
  • Web-Interface
  • Guides
    • Beginner
    • RTMP
    • SRT
    • Filesystems
  • General
    • Prometheus metrics
  • API
    • Login
    • Config
    • Log
    • Filesystem
      • Disk
      • In-memory
      • S3
    • Metrics
    • Sessions
    • Profiling
    • Ping
  • API / FFmpeg
    • Process
      • Command
      • Metadata
      • State
      • Probe
      • Report
    • Skills
    • Widget (Website)
  • API / RTMP
    • RTMP
  • API / SRT
    • SRT
  • Development
    • Architecture
    • Coding
    • Custom Docker images
    • Benchmark
    • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API / FFmpeg

Widget (Website)

PreviousSkillsNextRTMP

Last updated 2 years ago

Was this helpful?

This class of endpoints provide access to information that can be used for widgets in a website. These endpoints are not protected by the API access control.

Process

Fetch minimal statistics about a process. You need to know the process ID.

curl http://127.0.0.1:8080/api/v3/widget/process/someid \
   -H 'accept: application/json' \
   -X GET
from core_client import Client

client = Client(
    base_url="http://127.0.0.1:8080"
)
client.login()

core_widget_process = client.v3_widget_get_process(
    id="test"
)
print(core_widget_process)

This is not implemented in the GoClient.

Fetch minimal statistics about a process

get

Fetch minimal statistics about a process, which is not protected by any auth.

Path parameters
idstringRequired

ID of a process

Responses
200
OK
application/json
404
Not Found
application/json
get
GET /v3/widget/process/{id} HTTP/1.1
Host: api
Accept: */*
{
  "current_sessions": 1,
  "total_sessions": 1,
  "uptime": 1
}
  • Process
  • GETFetch minimal statistics about a process