-
Notifications
You must be signed in to change notification settings - Fork 810
API Key Authentication
Note | The Emby API supports two different authentication schemes.
This page describes API Key Authentication. Please also see |
---|
API Key Authentication allows accessing the Emby Server API by using a static token. Authentication via API key is the right choice for integration scenarios with other applications, servers or services that are not tied to a certain user's context. To grant access to an external service or server application you will need to create an API Key first.
Important: It is highly recommended to create separate API keys for each systemn you are granting access to your server. This will allow you to revoke a single access permissions without affecting the others.
To create an API key please follow these steps:
- You need to have access to a running installation of Emby Server as an administrator
- Open the Server Dashboard
This is the web UI where you have performed all configuration of Emby Server
- On the main dashboard page scroll down to the bottom of menu pane on the left
- Under Expert click Advanced
- On the top bar click Security
- Click Add and in the following dialog, enter a name for the API key for easy identification
The API key must be included in every request made that requires autjhentication. There are two different ways for specifying the API in an http request
Send the API key string in an http request heaser named X-Emby-Token.
An even easier method is to transmit the API key as a query string parameter name api_key. Example:
http://localhost:8096/emby/System/Info?api_key=123456789987654321
Emby Home | Latest News | Emby Downloads | Emby Community Forums | © 2019 Emby LLC
- Locating the Server
- Emby Connect
- Browsing the Library
- Latest Items
- Item Information
- Item Types
- Images
- Items by Name
- Web Socket
- Remote Control
- Live TV
- Playlists
- Parental Control
- Filtering
- Sync
- Playback Guidelines
- Audio Streaming
- Video Streaming
- HTTP Live Streaming (HLS)
- Subtitles
- Playback Check-ins