Skip to content

API Description

Jump to bottom
dave-p edited this page Jan 14, 2018 · 12 revisions

API Description

TVHeadend provides the API using the HTTP protocol, by default via port 9981 though this can be changed in the TVH config. Both the GET and POST methods may be used.

The URL must include a username and password with access permissions to carry out the requested task. If TVHeadend has been started with the '--http_root' qualifier, the HTTP root must be included in the URL, thus eg

http://admin:[email protected]:9981/myHttpRoot/api/config/capabilities

The response from TVH follows the HTTP protocol and includes a status indicating successful completion or the nature of any error.

Data is usually returned as JSON, without any CR or LF characters - the examples given have been 'prettified' to make them easier to read. Functions which perform an action rather than return data will return an empty JSON object on successful completion.

Clone this wiki locally