Skip to content

Queue a bounded Presentation Network connection test

POST
/api/v1/presentation-networks/{id}/test
curl --request POST \
--url https://example.com/api/v1/presentation-networks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test \
--header 'Content-Type: application/json' \
--data '{ "screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

The selected assigned Linux player joins and leaves the network without starting AirPlay. The durable command contains only the network ID and timeout; credentials are fetched separately by the authenticated player.

id
required
string format: uuid
X-CSRF-Token
string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Media typeapplication/json
object
screenId
required
string format: uuid
Examplegenerated
{
"screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Connection test command queued

Media typeapplication/json
object
data
required
object
commandId
required
string format: uuid
screenId
required
string format: uuid
timeoutSeconds
required
integer
>= 15 <= 180
Examplegenerated
{
"data": {
"commandId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"screenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"timeoutSeconds": 1
}
}

Insufficient role, CSRF failure, or screen outside scope

Presentation Network or screen not found

Encryption key unavailable or AirPlay is active on the screen

Screen is not the assigned Linux player