Contents
Get Settings - Plugixa Stream
GET /plugixa-stream/v1/admin/settings
Every setting the plugin and its modules store, with the option lists the Settings screen offers.
Needs a user with the plugixa_stream_view capability (signed in with an Application Password or the login cookie). Administrators hold it; other roles only when you grant it.
Note. API keys and payment secrets are not part of these settings: each service keeps them apart and only says whether one is set.
Request
GET https://your-site.example/wp-json/plugixa-stream/v1/admin/settings
Responses
200 OK.
{
"success": true,
"data": {
"settings": {
"delete_data_on_uninstall": false,
"free_episodes": 5,
"provider": "self_hosted",
"watermark": false,
"color_preset": "cinema",
"app_name": "",
"autoplay_next": true,
"watch_page_id": 12
},
"choices": {
"providers": [
{
"id": "self_hosted",
"label": "This server (Media Library or URL)"
}
],
"fonts": ["inter"],
"watch_url": "https://your-site.example/watch/"
}
}
}
| Field | Type | Meaning |
|---|---|---|
data.settings |
object |
Every stored setting, defaults filled in |
data.choices |
object |
Option lists: providers, fonts, presets, font_stacks, pages, watch_url; with Pro currencies |
Free keys include delete_data_on_uninstall, free_episodes, provider, watermark, watch_page_id and the appearance keys (color_preset, logo_id, app_name, autoplay_next, trailer_autoplay, …). Pro adds the keys of its modules: prices and coins (currency, episode_price, coin_packs, vip_plans, checkin_ladder, …), ads_*, email_*, reviews_*, profiles_max, kids_max_rating, screens_limit, player_engine and the default track languages. See Settings.
Errors
| Status | Code | When |
|---|---|---|
401 / 403 |
plugixa_stream_forbidden |
The caller lacks the capability. |
Plus the errors every endpoint can return.
Examples
curl -s "https://your-site.example/wp-json/plugixa-stream/v1/admin/settings" \
-u "$WP_USER:$WP_APP_PASSWORD"
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-stream/v1/admin/settings');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_USERPWD => getenv('WP_USER') . ':' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
const response = await fetch('https://your-site.example/wp-json/plugixa-stream/v1/admin/settings', {
headers: {
'Authorization': `Basic ${btoa(`${process.env.WP_USER}:${process.env.WP_APP_PASSWORD}`)}`,
},
});
const { data } = await response.json();
Quick Links
Share