Skip to content
EncoreEncore

Overview

Encore admin API 1

Section titled “Encore admin API 1”

The contract between Encore’s web interface and its server. See https://nightah.github.io/encore/reference/api/.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/api/v1/aliases
POST
/api/v1/aliases
DELETE
/api/v1/aliases/{id}
POST
/api/v1/match
POST
/api/v1/auth/login
POST
/api/v1/auth/logout
GET
/api/v1/auth/oidc/callback
GET
/api/v1/auth/oidc/login
PUT
/api/v1/auth/password
GET
/api/v1/auth/state
POST
/api/v1/auth/totp/confirm
POST
/api/v1/auth/totp/disable
POST
/api/v1/auth/totp/enroll
POST
/api/v1/client-errors
POST
/api/v1/setup/admin
POST
/api/v1/setup/reachability
GET
/api/v1/config/export
POST
/api/v1/config/import
GET
/api/v1/settings
PATCH
/api/v1/settings
POST
/api/v1/settings/backups/run
POST
/api/v1/settings/secrets/rotate
POST
/api/v1/settings/storage/test
GET
/api/v1/devices
DELETE
/api/v1/devices/{id}
PATCH
/api/v1/devices/{id}
GET
/api/v1/events
GET
/api/v1/kodi/discovered
GET
/api/v1/kodi/instances
POST
/api/v1/kodi/instances
GET
/api/v1/kodi/instances/{id}
DELETE
/api/v1/kodi/instances/{id}
PATCH
/api/v1/kodi/instances/{id}
GET
/api/v1/kodi/instances/{id}/art
POST
/api/v1/kodi/instances/{id}/default
POST
/api/v1/kodi/instances/{id}/sync
POST
/api/v1/kodi/instances/{id}/test
POST
/api/v1/kodi/instances/{id}/wake
GET
/api/v1/libraries
POST
/api/v1/libraries/group
PATCH
/api/v1/libraries/{id}
GET
/api/v1/libraries/{id}/recent
POST
/api/v1/libraries/{id}/split
GET
/api/v1/oauth/lwa/callback
GET
/api/v1/skill
DELETE
/api/v1/skill/amazon
GET
/api/v1/skill/amazon/authorize
PUT
/api/v1/skill/amazon/credentials
POST
/api/v1/skill/amazon/paste
PUT
/api/v1/skill/content
POST
/api/v1/skill/deploy
GET
/api/v1/skill/deploy/{id}
GET
/api/v1/skill/package
PUT
/api/v1/skill/settings
GET
/api/v1/overview
GET
/api/v1/requests
GET
/api/v1/requests/{id}
POST
/api/v1/requests/{id}/replay
GET
/api/v1/rooms
POST
/api/v1/rooms
DELETE
/api/v1/rooms/{id}
PATCH
/api/v1/rooms/{id}
POST
/api/v1/rooms/{id}/aliases
DELETE
/api/v1/rooms/{id}/aliases/{alias_id}

Authentication

Section titled “Authentication”

session

Section titled “session”

Admin session; trusted-header requests from server.trusted_proxies are accepted too.

Security scheme type: apiKey

Cookie parameter name: encore_session