EN / DEContact

KNOWLEDGE / DIGITAL SIGNAGE (DS MANAGER)

Digital Signage: REST API

Every display device with the DS Player and every DS server offers the same HTTP interface. Endpoints, headers and a PowerShell example.

By INZOSO Resilience · Updated · 2 min read

Basics

  • Base address: http://<device>:8080
  • Format: JSON (UTF-8)
  • Write calls need the pairing key in the header X-Api-Key: <6-digit key>
  • Errors: JSON {"error": "…"} with HTTP status 400, 401, 404, 500 or 507

Read (no key, on the local network)

  • GET /api/status: name, version, playlist version, free storage, uptime, currently shown entry, IP, orientation
  • GET /api/playlist: current playlist
  • GET /api/media: list of stored media
  • GET /api/settings: orientation and quiet hours
  • GET /player: the player (HTML)
  • GET /media/<file>: media file (supports range requests)

Write (with X-Api-Key)

  • PUT /api/playlist: new playlist {"items":[…]}
  • PUT /api/device: device name {"name":"Reception"}
  • POST /api/media?name=<file>: upload a file (raw data in the body)
  • DELETE /api/media/<id>: delete a medium
  • PUT /api/settings: {"rotation":0|90|180|270, "quiet":{"enabled":true,"days":[1,2,3,4,5],"from":"20:00","to":"07:00"}}
  • PUT /api/alert: instant alert {"text":"…","mode":"full"|"banner","bg":"#B91C1C","fg":"#FFFFFF","minutes":30}
  • DELETE /api/alert: end the instant alert
  • POST /api/reload: reload the display
  • GET /api/playlog: playback log (CSV, semicolon-separated)

Playlist entry (excerpt)

An entry has fields such as id, type (image, video, pdf, text or dashboard), title, duration, enabled and mediaId (from /api/media). Optionally a schedule field with days, from, to, startDate and endDate. Weekdays: 0 = Sunday to 6 = Saturday. Without schedule the entry always runs.

Example schedule field: {"days":[1,2,3,4,5],"from":"11:00","to":"14:00","startDate":"2026-12-01","endDate":"2026-12-24"}

Example (Windows PowerShell)

$h = @{ 'X-Api-Key' = '123456' }
Invoke-RestMethod http://192.168.1.50:8080/api/alert -Method Put -Headers $h -ContentType 'application/json' -Body '{"text":"Fire drill 10 am","minutes":15}'

Device discovery

UDP broadcast with the text DS_DISCOVER to port 8081. Every device replies with {"name":"…","port":8080}.

Security

Write access is protected by the pairing key. The connection is unencrypted (HTTP). Only run the devices in trusted local networks and do not expose the ports to the internet.

digital signage REST APIinstant alert by scriptDS Player APIplaylist via APIdigital signage automation

Frequently asked questions

Do read calls need a key?

No. Read calls are open on the local network. Write calls need the pairing key in the X-Api-Key header.

Is the API encrypted?

No, it uses unencrypted HTTP. Only run it in trusted networks.

KEEP READING

Next step

Have a specific question?

Send us a short description of your situation. We will assess it and tell you openly whether and how we can help.

Request a conversation