Get information on a specific plugin.
curl --request GET \
--url http://localhost:5754/api/plugin/{pluginId} \
--header 'Authorization: <api-key>'import requests
url = "http://localhost:5754/api/plugin/{pluginId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://localhost:5754/api/plugin/{pluginId}', 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/plugin/{pluginId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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/plugin/{pluginId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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/plugin/{pluginId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5754/api/plugin/{pluginId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"instance": {
"v2": true,
"name": "OBS Control",
"author": "Freedeck",
"imports": [],
"Settings": {
"password": "-REDACTED-"
},
"hooks": [
{
"type": 4,
"name": "editor.view"
},
{
"type": 1,
"name": "oc/server.js"
},
{
"type": 0,
"name": "oc/server.js"
}
],
"views": {
"OBS Control": "editor.view"
},
"dashModules": {},
"id": "obscontrol",
"stopped": false,
"hasInit": true,
"popout": "",
"_hookLocation": "user-data/hooks/",
"_usesAsar": false,
"_id": "opi9xi",
"_callbacks": {
"0": [
null
]
},
"_intent": [
0,
1
],
"io": {
"active": false
},
"types": [
{
"type": "obs.cf",
"renderType": "button",
"templateData": {
"password": "change-me"
},
"name": "Reconnect to OBS",
"pluginId": "obscontrol",
"hidden": true,
"display": "OBS Control"
}
],
"currentDataPacket": {},
"version": "2.0.0",
"file": {
"filePath": "obscontrol.fdpackage"
}
}
}Discovery API
Get information on a specific plugin.
GET
/
api
/
plugin
/
{pluginId}
Get information on a specific plugin.
curl --request GET \
--url http://localhost:5754/api/plugin/{pluginId} \
--header 'Authorization: <api-key>'import requests
url = "http://localhost:5754/api/plugin/{pluginId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://localhost:5754/api/plugin/{pluginId}', 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/plugin/{pluginId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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/plugin/{pluginId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
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/plugin/{pluginId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5754/api/plugin/{pluginId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"instance": {
"v2": true,
"name": "OBS Control",
"author": "Freedeck",
"imports": [],
"Settings": {
"password": "-REDACTED-"
},
"hooks": [
{
"type": 4,
"name": "editor.view"
},
{
"type": 1,
"name": "oc/server.js"
},
{
"type": 0,
"name": "oc/server.js"
}
],
"views": {
"OBS Control": "editor.view"
},
"dashModules": {},
"id": "obscontrol",
"stopped": false,
"hasInit": true,
"popout": "",
"_hookLocation": "user-data/hooks/",
"_usesAsar": false,
"_id": "opi9xi",
"_callbacks": {
"0": [
null
]
},
"_intent": [
0,
1
],
"io": {
"active": false
},
"types": [
{
"type": "obs.cf",
"renderType": "button",
"templateData": {
"password": "change-me"
},
"name": "Reconnect to OBS",
"pluginId": "obscontrol",
"hidden": true,
"display": "OBS Control"
}
],
"currentDataPacket": {},
"version": "2.0.0",
"file": {
"filePath": "obscontrol.fdpackage"
}
}
}