Identifies a running Freedeck Server.
curl --request GET \
--url http://localhost:5754/api/discoverimport requests
url = "http://localhost:5754/api/discover"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:5754/api/discover', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5754",
CURLOPT_URL => "http://localhost:5754/api/discover",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:5754/api/discover"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:5754/api/discover")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5754/api/discover")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"title": "Freedeck",
"version": "6.0.0-rc4",
"plugins": [
[
"obscontrol",
"v2.0.0"
]
],
"webpackStatus": "compiling",
"deviceStatus": true,
"ip": "<string>",
"myApp": {
"code": "ABCDEF",
"host": "https://my.freedeck.app/"
}
}Discovery API
Identifies a running Freedeck Server.
GET
/
api
/
discover
Identifies a running Freedeck Server.
curl --request GET \
--url http://localhost:5754/api/discoverimport requests
url = "http://localhost:5754/api/discover"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:5754/api/discover', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5754",
CURLOPT_URL => "http://localhost:5754/api/discover",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:5754/api/discover"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:5754/api/discover")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5754/api/discover")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"title": "Freedeck",
"version": "6.0.0-rc4",
"plugins": [
[
"obscontrol",
"v2.0.0"
]
],
"webpackStatus": "compiling",
"deviceStatus": true,
"ip": "<string>",
"myApp": {
"code": "ABCDEF",
"host": "https://my.freedeck.app/"
}
}Response
200 - application/json
OK
Example:
"Freedeck"
Example:
"6.0.0-rc4"
A list of currently installed plugins.
Can be any of 'uninitialized', 'compiling', or 'ready'. Used to halt immediate Companion connection to await bundles being fresh and ready.
Example:
"compiling"
Whether or not the user's external Freedeck Client is connected
The local IPs discovered on the machine.
MyFreedeck properties
Show child attributes
Show child attributes