---
description: >-
  OvenMediaEngine Enterprise는 REST API Server를 버전 0.11.0.0-1부터 지원합니다. 그러나 각 기능에
  제공되는 API는 OvenMediaEngine Enterprise 버전에 따라 다를 수 있으므로 기능마다 표시된 최소 버전을 확인해주십시오.
---

# REST API Settings

OvenMediaEngine에서 제공하는 REST API를 사용하면 `<VirtualHost>`, `<Application>/<Stream>` 등의 기능을 쿼리하거나 설정을 변경할 수 있습니다.

## API Server Port 설정하기

<figure><img src="https://content.gitbook.com/content/Z6NWzeQyKbSWkDFSGwGx/blobs/0g5jp2BnLCVR2KjfnmJD/image.png" alt=""><figcaption><p>REST API Settings 내 Bind Settings</p></figcaption></figure>

기본적으로 OvenMediaEngine의 API Server는 비활성화되어 있으므로 API를 사용하려면 REST API Settings 페이지 내 우측에 위치한 토글 버튼을 눌러 기능을 활성화해야 합니다. 또, 해당 페이지에서 각 `Application`에서 사용하는 REST API의 Port 및 구성 정보를 검토하고 수정할수 있습니다.&#x20;

* `Port`: Server가 HTTP 요청을 수신하기 위해 사용할 `Port`를 설정하는 옵션입니다.
* `TLS Port`: Web Browser와 Server 간에 TLS (Transport Layer Security) Protocol을 사용하여 Data를 암호화합니다. 해당 옵션에 설정된 `Port`를 통해 암호화된 Data가 전송됩니다.
* `Worker Count`: 데이터 처리에 사용할 스레드 수를 설정하는 옵션입니다.

## Managers 설정하기

<figure><img src="https://content.gitbook.com/content/Z6NWzeQyKbSWkDFSGwGx/blobs/tpTs5kKufuOuXnc8J4TM/image.png" alt=""><figcaption><p>REST API Settings 내 Managers Settings</p></figcaption></figure>

* `Name`: API 서버에 액세스할 수 있는 `Domain` 또는 `IP`를 기입합니다.
  * _<mark style="color:blue;">우측에 위치한</mark> <mark style="color:blue;"></mark><mark style="color:blue;">`+`</mark><mark style="color:blue;">버튼을 눌러 여러개의 Domain 또는 IP를 추가할 수 있습니다.</mark>_

### TLS 설정하기 | 0.14.0.0+

* `Cert Path`: TLS 인증서를 구성하고 있는 `.crt` 파일의 이름과 경로를 보여줍니다.
* `Chain Cert Path`: TLS 인증서를 구성하고 있는 `.ca-bundle` 파일의 이름과 경로를 보여줍니다.
* `Key Path`: TLS 인증서를 구성하고 있는 `.key` 파일의 이름과 경로를 보여줍니다.

### API 설정하기

* `Access Token`:  기본 HTTP 인증 체계를 사용하여 Client를 인증할 때 사용하는 토큰입니다.
  * _<mark style="color:blue;">필수는 아니지만</mark> <mark style="color:blue;"></mark><mark style="color:blue;">`RFC7617`</mark><mark style="color:blue;">에 따라 Access Token을</mark> <mark style="color:blue;"></mark><mark style="color:blue;">`user-id:password`</mark> <mark style="color:blue;"></mark><mark style="color:blue;">형식으로 설정하면 표준 Browser에서 쉽게 인증할 수 있습니다.</mark>_
* `Cross Domain`: `<CorssDomain>`을 통해 Player가 동작하는 도메인을 제어합니다.

{% hint style="info" %}
세부 가이드: [https://airensoft.gitbook.io/ovenmediaengine/rest-api](https://airensoft.gitbook.io/ovenmediaengine/rest-api)
{% endhint %}

### [API Storage](../operations-and-monitoring/api-storage) 설정하기 | 0.17.0.0+

* `Enabled`: 해당 옵션을 통해 `Storage` 기능을 활성화하거나 비활성화할 수 있습니다.
* `Path`:   API 정보를 저장할 경로를 지정할 수 있습니다.
