OvenMediaEngine Enterprise
English
English
  • Introduction
  • OvenMediaEngine Configuration
  • Getting Started
    • Getting Started with Ubuntu
    • Getting Started with RHEL
    • Getting Started with Docker
  • Enterprise-grade Features
    • Web Console
      • Web Console Configuration
      • Sign In
      • Change Password
      • Web Console Home
        • Stream List
      • Stream Monitoring
        • Managed and Instant Streams
        • Scheduled Channels | 0.16.4.0+
        • Multiplex Channels | 0.16.5.0+
      • Monitoring
      • Logs
      • Configuration Files
      • Settings
        • Server
        • Live Sources (Ingress Protocols)
          • RTMP | 0.9.0.0+
          • WebRTC/WHIP | 0.12.0.0+/0.15.1.0+
          • SRT | 0.12.0.0+
          • MPEG-2 TS | 0.10.4.0+
          • Scheduled Channels | 0.16.4.0+
          • Multiplex Channels | 0.16.5.0+
        • ABR and Transcoding
          • Transcoding
          • Output Profiles
          • Adaptive Bitrate Streaming (ABR) | 0.14.3.0+
          • Encodes
          • Conditional Transcoding
        • Streaming (Egress Protocols)
          • WebRTC/WHIP | 0.9.0.0+/0.15.1.0+
          • Low Latency HLS (LLHLS) | 0.14.0.0+
          • Legacy HLS | 0.16.6.0+
        • TLS Encryption | 0.14.0.0+
        • Access Control
          • Signed Policy | 0.12.0.0+
          • Admission Webhooks | 0.12.2.0+
        • Thumbnail | 0.15.7.0+
        • Recording | 0.16.5.0+
        • Push Publishing | 0.15.14.0+
        • REST API | 0.11.0.0+
        • Alert | 0.15.11.0+
      • Restart
    • Record Delivery | 0.16.5.0+
    • Digital Rights Management (DRM)
      • OvenMediaEngine Configuration for DRM | 0.16.0.0+
      • PallyCon DRM Configuration | 0.16.4.0+
    • Hardware-Accelerated Video Encoding | 0.16.4.0+
    • Proxy Protocol Integration | 0.16.6.2+
    • Event Monitoring | 0.18.1.0+
      • Configuration
      • Event Specification
    • Web Console Publishing | 0.18.1.2+
  • Advanced Management Tools
    • API Storage | 0.17.0.0+
    • Restart Application | 0.17.0.0+
    • Publisher Extension
    • RTMP Authentication | 0.17.2.0+
    • Generating Audio PTS | 0.17.2.3+
    • Inserting AMF0 messages in RTMP Push Publisher | 0.17.3.0+
    • Inserting Ad Markers (EXT-X-CUE-OUT/EXT-X-CUE-IN) | v0.17.3.0+
    • Inserting SEI into H.264 (AVC) Streams | v0.18.0.0+
  • Release Notes
    • 0.18.1 (May 9, 2025 update)
    • 0.18.0
    • 0.17.3
    • 0.17.2
    • 0.17.1
    • 0.17.0
    • 0.16.8
    • 0.16.7
    • 0.16.6
    • 0.16.5
    • 0.16.4
Powered by GitBook
On this page
  • API Server Port Settings
  • Managers Settings
  • TLS Settings | 0.14.0.0+
  • API Settings
  • API Storage Settings | 0.17.0.0+
  1. Enterprise-grade Features
  2. Web Console
  3. Settings

REST API | 0.11.0.0+

OvenMediaEngine Enterprise supports REST API Server from version 0.11.0.0-1. However, the APIs provided for each function may differ depending on the OvenMediaEngine Enterprise's version.

PreviousPush Publishing | 0.15.14.0+NextAlert | 0.15.11.0+

Last updated 6 months ago

The REST APIs provided by OvenMediaEngine allow you to query or change settings such as <VirtualHost> and <Application>/<Stream>.

API Server Port Settings

By default, the OvenMediaEngine API Server is disabled, so to use the API, you need to enable the feature by clicking the toggle button on the right side of the REST API Settings page. You can also review and modify the Port and Configuration for the REST APIs used by each Application on that page.

  • Port: The Port that the server will use to receive HTTP requests

  • TLS Port: Data is encrypted using the Transport Layer Security (TLS) Protocol between the web browser and the server. The encrypted data is transmitted over the Port.

  • Worker Count: Sets the number of threads to use for data processing.

Managers Settings

  • Name: Enter the Domain or IP that can access the API Server.

    • You can add multiple Domains or IPs by clicking the + button on the right.

TLS Settings | 0.14.0.0+

  • Cert Path: Shows the name and path of the .crt file that composes the TLS certificate.

  • Chain Cert Path: Shows the name and path of the .ca-bundle file that constitutes the TLS certificate.

  • Key Path: Shows the name and path of the .key file that composes the TLS certificate.

API Settings

  • Access Token: Access Token is used to authenticate a client using the basic HTTP authentication scheme.

    • Although RFC7617 format is not required, you can easily pass the authentication in a standard browser by setting the Access Token in the user-id:password format.

  • Cross Domains: Most browsers and players prohibit accessing other domain resources in the currently running domain. You can control this situation via this option.

  • Enabled: Sets can enable or disable Storage.

  • Path: Specifies the path where API information will be stored.

Detailed Guide:

Settings | 0.17.0.0+

https://airensoft.gitbook.io/ovenmediaengine/rest-api
API Storage
In the Bind of the REST API Settings
In the Managers of the REST API Settings