Replay Servers Device Auth

post

Body

deviceIdstringRequired

Unique device identifier (e.g., Mac mini MAC address or UUID)

hostnamestringOptional

Device hostname for display

versionstringOptional

Software version running on the device

displayNamestringOptional

Display name for the device (set during first-time setup)

serverUrlstringOptional

External DDNS or URL where this server is reachable

localIpstringOptional

Local network IP address of the device

Responses

200

Returns server ID for polling status

application/json

serverIdstringRead-onlyRequired

The server ID to use for polling status

statusstring · enumRead-onlyRequired

Current status of the registration

Possible values:

pollIntervalnumberRead-onlyRequired

Recommended polling interval in seconds

displayNamestringRead-onlyOptional

Existing display name (if already set)

post/replay-servers/device

POST /apis/v2/replay-servers/device HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "deviceId": "text",
  "hostname": "text",
  "version": "text",
  "displayName": "text",
  "serverUrl": "text",
  "localIp": "text"
}

200

Returns server ID for polling status

{
  "serverId": "text",
  "status": "PENDING",
  "pollInterval": 1,
  "displayName": "text"
}

get

Path parameters

serverIdstringRequired

The server ID from registration

Query parameters

versionstringOptional

Current software version running on the device

serverUrlstringOptional

External DDNS or URL where this server is reachable

localIpstringOptional

Local network IP address of the device

Responses

200

Returns current status and token when approved

application/json

statusstring · enumRead-onlyRequired

Current status

Possible values:

accessTokenstringRead-onlyOptional

The access token (only when approved)

404

Server not found

get/replay-servers/device/{serverId}/status

GET /apis/v2/replay-servers/device/{serverId}/status HTTP/1.1
Accept: */*

{
  "status": "PENDING",
  "accessToken": "text",
  "area": {
    "id": "text"
  },
  "pendingUpdate": {
    "version": "text"
  },
  "config": {
    "apiBaseUrl": "text",
    "gcpStorageBucket": "text",
    "logoPath": "text",
    "logoPlacement": "bottom-right",
    "gcpCredentialsPath": "text",
    "postrollPath": "text",
    "cleanupEnabled": true,
    "cameras": [
      {
        "id": "text",
        "name": "text",
        "feed": "text",
        "feed2": "text",
        "isEnabled": true,
        "videoCodec": "h264",
        "audioCodec": "aac",
        "distortion1": 1,
        "distortion2": 1,
        "rotation": 1,
        "scale": 1,
        "vignette": 1,
        "lutPath": "text"
      }
    ]
  }
}