Skip to content
Tilecast Docs

stopAirplaySession

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

Stop an AirPlay Present session. Requires an Owner or Administrator with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token. The server commits the stop transition and required Player cleanup commands together. Retry if the server returns 503.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Header Parameters

Section titled “Header Parameters”
X-CSRF-Token
string

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
reason
string
<= 120 characters
Examplegenerated
{
  "reason": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

AirPlay session stopped

Media typeapplication/json
object
data
required

Temporary AirPlay Present session. The PIN appears only while the session is preparing, waiting, or active, and only when the server issued one. Null audio and network ids mean no audio screen and no Presentation Network, respectively.

object
id
required
string format: uuid
provider
required
string
Allowed values: airplay
status
required
string
Allowed values: preparing waiting active stopping ended expired failed
targetType
required
string
Allowed values: screen group
targetId
required
string format: uuid
gatewayScreenId
required
string format: uuid
audioScreenId
required
string | null format: uuid
receiverName
required
string
pin
string
expiresAt
required
string format: date-time
createdAt
required
string format: date-time
endedAt
string | null format: date-time
endReason
required
string
transport
required
string
Allowed values: auto unicast multicast
videoProfile
required
string
audioMode
required
string
Allowed values: gateway_only none
presentationNetworkId
required
string | null format: uuid
presentationNetworkName
required
string
screenCount
required
integer
readyCount
required
integer
connectedCount
required
integer
failedCount
required
integer
screens
required
Array<object>
object
screenId
required
string format: uuid
screenName
required
string
role
required
string
state
required
string
lastUpdatedAt
required
string format: date-time
failureCode
string
failureMessage
string
presentationNetworkState
string
Example
{
  "data": {
    "provider": "airplay",
    "status": "preparing",
    "targetType": "screen",
    "transport": "auto",
    "audioMode": "gateway_only"
  }
}

400

Section titled “400”

Invalid request body

401

Section titled “401”

Dashboard authentication required

403

Section titled “403”

Insufficient role or screen scope

404

Section titled “404”

AirPlay session not found

422

Section titled “422”

Stop reason too long

503

Section titled “503”

Stop transition or required Player cleanup command could not be committed; retry the request