Skydrix API for operators and integrations.

Payment callbacks

Visa and Mastercard use the e-Xezine hosted checkout. SkydrixWeb never accepts card details and never treats a browser return URL as proof of payment.

Only a final successful status independently queried from e-Xezine can create an order or renew licenses. Duplicate notifications are safe; unresolved intents are reconciled after restarts.

1. API basics

All API methods are served by the Skydrix application itself, usually at the same host and port as the web UI.

Base URL: http://<skydrix-host>:<port>
Content-Type: application/json

When authentication is enabled, API calls require the `skydrix_session` cookie returned by the login endpoint. Static files, the home page, `POST /api/auth/login`, and `GET /api/auth/me` are available without an existing session.

2. Authentication

Login request:

{
  "username": "admin",
  "password": "secret"
}

Successful login returns user data and sets `Set-Cookie: skydrix_session=...`.

3. Configuration API

The configuration API reads and writes the full Skydrix runtime configuration: transponders, channels, output URLs, Softcam servers, HLS settings, notification settings, and monitoring settings.

Important behaviour when saving config:

• Transponder ID renames are cascaded to related channels.
• Softcam ID renames are cascaded to channels and `dvb://` input URLs.
• Changed DVB tuning parameters restart affected active streams.
• Changed Softcam credentials are hot-reloaded where possible.
• The response is the final server-reconciled configuration.

4. Channel management API

Use these endpoints when an external panel or automation needs to edit one channel without replacing the full configuration JSON. A channel is addressed by `transponder_id` and `program_number`; in the table below `{tp}` means `transponder_id` and `{pnr}` means `program_number`.

Rename a channel and disable it:

PATCH /api/channels/astra-11550v/501
{
  "id": "bbc-news",
  "name": "BBC News HD",
  "enabled": false
}

Create a custom channel using point API:

POST /api/channels
{
  "id": "ext-feed-1",
  "name": "External Feed",
  "transponder_id": "virt-feed1",
  "program_number": 1,
  "channel_type": "url",
  "input_urls": ["http://origin.example.com/live/index.m3u8"],
  "outputs": ["http://0.0.0.0:9010/ext-feed-1/index.m3u8"],
  "enabled": true,
  "start_immediately": true
}

Assign a Softcam server or switch to a BISS key. These are mutually exclusive: setting one clears the other.

{
  "softcam_id": "cam-main",
  "biss_key": null
}

{
  "biss_key": "1122334455667788",
  "softcam_id": null
}

Assign an imported provider channel as this channel's Pro EPG source:

{
  "epg_provider_id": "vsetv.com",
  "epg_channel_number": "3",
  "epg_provider_channels": {
    "vsetv.com": "3",
    "ntvplus.ru": "42"
  }
}

Replace all inputs/outputs at once, or add/remove individual URLs. Remote URL inputs support udp://, rtp://, http://, https://, srt://, and rtsp://; SRT/RTSP require ffmpeg on the Skydrix host.

{
  "input_urls": ["dvb://astra-11550v/501/cam-main", "udp://10.10.10.5:5000", "srt://source.example.com:9000?mode=caller"],
  "outputs": ["udp://239.10.0.1:5000", "http://0.0.0.0:9001"]
}

POST /api/channels/astra-11550v/501/outputs
{
  "url": "http://0.0.0.0:9001/index.m3u8",
  "index": 1
}

Pro Channel Schedule is stored in the same channel object as schedules. There is no separate schedule endpoint yet: update schedules with PATCH /api/channels/{tp}/{pnr} or with full PUT /api/config.

• Any active schedule window forces the channel off.
• Overlapping schedules are additive: if any window is active, the channel stays off.
• When no schedule is active, the channel can run only if enabled=true and outputs exist.
• In non-Pro builds the Schedule UI is locked and the runtime worker is disabled.

One-time schedule example:

PATCH /api/channels/virt-feed1/1
{
  "schedules": [
    {
      "id": "sch-maint-1",
      "mode": "one_time",
      "enabled": true,
      "start_at": 1770000000,
      "finish_at": 1770003600
    }
  ]
}

Weekly schedule example. Weekdays use 0..6 for Sun..Sat; 7 is normalized to 0.

{
  "schedules": [
    {
      "id": "sch-nightly",
      "mode": "weekly",
      "enabled": true,
      "weekdays": [1, 2, 3, 4, 5],
      "start_hour": 1,
      "start_minute": 30,
      "finish_hour": 6,
      "finish_minute": 0
    }
  ]
}

Monthly/date schedule example. Monthly rules repeat every year; year may be retained as legacy metadata but does not make the rule one-shot.

{
  "schedules": [
    {
      "id": "sch-may-18",
      "mode": "monthly",
      "enabled": true,
      "month": 5,
      "month_days": [18],
      "start_hour": 2,
      "start_minute": 0,
      "finish_hour": 4,
      "finish_minute": 30
    }
  ]
}

If an edited channel is currently active, runtime-affecting changes restart it automatically. Setting `enabled:true` starts it when outputs are configured; setting `enabled:false` or removing all outputs stops it.

Custom-channel helper requests:

POST /api/channels/test-input
{
  "url": "https://example.com/live/index.m3u8"
}

POST /api/channels/media-playlist
{
  "directory": "/media/videos"
}

GET /api/channels/astra-11550v/501/media-info

POST /api/channels/scheduled-playlists
{
  "directory": "/media/playlists"
}

5. Pro transcoding API

FFmpeg channel transcoding is available only in Pro builds. Standard builds return 403 for these endpoints.

media_transport

media_transport controls the media-plane source protocol for a transcoding job. It does not affect the HTTPS/mTLS control channel between Skydrix and skydrix-agent. Allowed values are auto, http, srt, and rist.

• auto or an omitted value is normalized from source_url: http:// and https:// become http, srt:// becomes srt, and rist:// becomes rist.
• An explicit value must match the source_url scheme; for example, media_transport=srt requires an srt:// source.
• Source URLs may use HTTP(S), SRT, or RIST and must not contain embedded credentials.
• Agent placement checks FFmpeg capabilities before assignment. SRT and RIST jobs require agents whose FFmpeg reports the corresponding input protocol.
• For SRT sources, agents add safe live defaults when omitted: mode=caller, transtype=live, and latency=300000.

Direct job request:

POST /api/transcoding/jobs
{
  "id": "news-main",
  "channel_id": "astra-11550v:501",
  "source_url": "srt://encoder.example.com:9000?streamid=news-main",
  "media_transport": "srt",
  "profile_ids": ["360p", "720p"],
  "pinned_agent_id": null
}

Channel-scoped patch body:

PATCH /api/channels/astra-11550v/501/transcoding
{
  "enabled": true,
  "profile_ids": ["360p", "720p"],
  "pinned_agent_id": null
}

• Enabling channel transcoding requires explicit enabled=true and at least one selected profile.
• Control traffic stays HTTPS/mTLS. media_transport controls only the media-plane source protocol and must match source_url.
• Channel jobs use the channel active input_urls[0] source, which must be HTTP(S), SRT, or RIST without credentials. SRT jobs require an agent whose FFmpeg reports SRT input support.
• The channel UI and channels[].outputs expose only the generated master playlist URL.
• The master playlist endpoint returns 404 when no desired job exists and 409 until at least one rendition URL is published.

Skydrix agent API (mTLS)

These endpoints are exposed by skydrix-agent on its control listener and are intended only for Skydrix Pro over mutual TLS. HLS files are served separately by the agent stream listener.

6. Transponder management API

Use these endpoints when an external panel or automation needs to manage one DVB transponder without replacing the full configuration JSON. A transponder is addressed by its `id`.

Create or patch a transponder:

{
  "id": "astra-11550v",
  "name": "Astra 11550 V",
  "enabled": true,
  "adapter": 0,
  "frequency": 11550,
  "polarization": "V",
  "symbol_rate": 27500,
  "lof1": 9750,
  "lof2": 10600,
  "slof": 11700,
  "lnb_power_mode": "auto",
  "dvb_type": "DVB-S2",
  "fec": "3/4",
  "modulation": "8PSK"
}

Renaming a transponder cascades to related channels and matching `dvb://old-id/...` input URLs. Changing tune parameters restarts active pipelines for that transponder.

7. Hardware and signal

The legacy debug routes remain compatibility aliases for the canonical DVB tuner endpoints.

`/api/tune` and `/api/scan` use the same tune parameters:

{
  "adapter": 0,
  "frequency": 11550,
  "polarization": "V",
  "symbol_rate": 27500,
  "lof1": 9750,
  "lof2": 10600,
  "slof": 11700,
  "lnb_power_mode": "auto",
  "dvb_type": "DVB-S2",
  "fec": "3/4",
  "modulation": "8PSK"
}

lnb_power_mode is auto by default. Set it to external only for a passive shared coax feed powered and band-selected by another receiver; Skydrix then disables its local LNB supply and does not control the 22 kHz tone. When /api/scan receives the ID of a transponder already active on the requested adapter, it reads service tables without retuning. Otherwise it temporarily pauses active pipelines on that adapter. The HTTP timeout is 120 seconds.

8. Streaming control

Start or stop request:

{
  "transponder_id": "astra-11550v",
  "channel_pnr": 501
}

Status response contains stream keys such as `astra-11550v:501` and values with `active`, `outputs`, `started`, `bitrate_kbps`, `dvr_error`, `scrambled`, `errors`, and `active_input_url`.

Supported output URL families include UDP, RTP, HTTP MPEG-TS, and HLS:

udp://239.10.0.1:5000
rtp://239.10.0.1:5000
http://0.0.0.0:9001
http://0.0.0.0:9001/index.m3u8

9. Operational tools

Parse satellite URL request:

{
  "url": "https://example.com/satellite/transponders"
}

Softcam test request:

{
  "host": "127.0.0.1",
  "port": 15000,
  "login": "user",
  "password": "pass",
  "des_key": "01 02 03 04 05 06 07 08 09 10 11 12 13 14"
}

EPG provider refresh request:

{
  "provider_id": "vsetv.com"
}

Each provider may define an individual time offset applied when programme start/end times are returned, including schedules already stored in SQLite:

{
  "providers": [
    {
      "id": "vsetv.com",
      "enabled": true,
      "region": "1",
      "time_offset": "+04:00"
    }
  ]
}

Optional FTP publication settings. A blank password preserves the previously stored secret; clearing host and username disables FTP upload:

{
  "ftp": {
    "protocol": "ftp",
    "host": "epg.example.com:21",
    "directory": "/xmltv",
    "username": "publisher",
    "password": "secret"
  }
}

The generated document is uploaded as epg.xml after a successful local generation. The optional directory selects the FTP destination directory and defaults to /. The password is stored separately in /etc/skydrix/epg/ftp_credentials.json with mode 0600 and is not returned by the API.

Download one provider channel schedule:

{
  "provider_id": "vsetv.com",
  "channel_number": "3"
}

Automatic EPG updates are Pro-only and disabled until the schedule is saved. The backend accepts selected weekdays (0 Sunday through 6 Saturday), hour, minute, and an IANA timezone. A scheduled cycle refreshes every enabled provider channel catalog and then every EPG assignment for that provider through one sequential runtime pipeline. Provider files are read from /etc/skydrix/epg; channel snapshots and import history are stored in /etc/skydrix/epg/epg.db.

10. Users and preferences

User management endpoints are intended for installations with Skydrix authentication enabled. Admin-only methods require an admin session.

Preferences include visual theme, language, card zoom, saved panel width, and Telegram settings:

{
  "theme": "dark",
  "ui_theme": "aurora",
  "card_scale": 1.0,
  "resizer_left_px": 420,
  "lang": "en",
  "telegram": {
    "chat_id": "-1001234567890",
    "bot_token": "bot123456789:example",
    "use_custom_url": false,
    "use_custom_bot": false
  }
}

For a custom Telegram gateway, send `use_custom_url=true`, `custom_url`, `use_custom_bot=true`, and `custom_bot_path`. Custom URL send/test uses insecure TLS verification, similar to `curl --insecure`.

{
  "telegram": {
    "chat_id": "-1001234567890",
    "use_custom_url": true,
    "custom_url": "freegate.yourserver.com",
    "use_custom_bot": true,
    "custom_bot_path": "/telegram/Bot"
  }
}

11. Errors and status codes

Most successful write operations return `{"ok":true}`. Validation and operational failures return a non-2xx status with either plain text or a JSON object containing `error`.