Skip to content

Depot displays

Registers the account’s display and session routes.

This page is generated from the Depot route table. Every operation carries the permission it needs and the anchor an agent can link to.

GETshared facehosteditmspremoteIdempotent

Source: [object Object]

listMyDisplays lists the TV displays you activated that are still paired.

StatusBodyDescription
200application/json, DisplayListSuccess.

200 response body

FieldTypeDescription
displaysrequiredarray of DisplayItem
displays[].activatedAtrequiredstring (date-time)
displays[].activatedBystring
displays[].boardNamerequiredstring
displays[].deviceLabelrequiredstring
displays[].idrequiredstring
displays[].lastSeenAtrequiredstring (date-time)
Terminal window
# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/console/me/displays' \
-H 'X-CSRF-Token: <csrf-token>' \
-H 'Accept: application/json' \
-b 'outpost_console=<console-session>'

DELETEshared facehosteditmspremoteIdempotent

Source: [object Object]

revokeMyDisplay unpairs one of your own displays; its next refresh returns it to the pairing screen.

Someone else’s display is 404.

NameInTypeRequiredDescription
idpathstringYes
StatusBodyDescription
204NoneSuccess, with no body.
404application/problem+json, ProblemDetailsNo resource matches that id.
Terminal window
# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X DELETE 'https://depot.example.com/api/v1/console/me/displays/<id>' \
-H 'X-CSRF-Token: <csrf-token>' \
-H 'Accept: application/json' \
-b 'outpost_console=<console-session>'

GETdashboard:tvshared facehosteditmspremoteIdempotent

Source: [object Object]

lookupDisplayPairing reads the waiting TV a pairing code names: the board, the device and where the request came from, so the approver can tell their own TV from someone else’s.

NameInTypeRequiredDescription
codequerystringNo
StatusBodyDescription
200application/json, PairingLookupSuccess.
401application/problem+json, ProblemDetailsNo signed-in identity.
403application/problem+json, ProblemDetailsThe identity does not hold dashboard:tv.

200 response body

FieldTypeDescription
boardNamerequiredstring
deviceLabelrequiredstring
requestedAtrequiredstring (date-time)
requestedFromrequiredstring
Terminal window
# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/console/me/displays/pairing?code=<code>' \
-H 'X-CSRF-Token: <csrf-token>' \
-H 'Accept: application/json' \
-b 'outpost_console=<console-session>'

POST /api/v1/console/me/displays/pairing/approve

Section titled “POST /api/v1/console/me/displays/pairing/approve”

POSTdashboard:tvshared facehosteditmspremote

Source: [object Object]

approveDisplayPairing pairs the waiting TV with your account: it will show what you may see.

Single use.

Required, sent as application/json.

FieldTypeDescription
coderequiredstring
StatusBodyDescription
204NoneSuccess, with no body.
400application/problem+json, ProblemDetailsThe request body is not acceptable.
401application/problem+json, ProblemDetailsNo signed-in identity.
403application/problem+json, ProblemDetailsThe identity does not hold dashboard:tv.
Terminal window
# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X POST 'https://depot.example.com/api/v1/console/me/displays/pairing/approve' \
-H 'X-CSRF-Token: <csrf-token>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-b 'outpost_console=<console-session>' \
--data '{
"code": "string"
}'

POST /api/v1/console/me/displays/pairing/deny

Section titled “POST /api/v1/console/me/displays/pairing/deny”

POSTdashboard:tvshared facehosteditmspremote

Source: [object Object]

denyDisplayPairing refuses the waiting TV; its next poll answers denied.

Required, sent as application/json.

FieldTypeDescription
coderequiredstring
StatusBodyDescription
204NoneSuccess, with no body.
400application/problem+json, ProblemDetailsThe request body is not acceptable.
401application/problem+json, ProblemDetailsNo signed-in identity.
403application/problem+json, ProblemDetailsThe identity does not hold dashboard:tv.
Terminal window
# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X POST 'https://depot.example.com/api/v1/console/me/displays/pairing/deny' \
-H 'X-CSRF-Token: <csrf-token>' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-b 'outpost_console=<console-session>' \
--data '{
"code": "string"
}'

GETshared facehosteditmspremoteIdempotent

Source: [object Object]

listMySessions lists the browsers signed in to your account.

StatusBodyDescription
200application/json, SessionListSuccess.

200 response body

FieldTypeDescription
sessionsrequiredarray of SessionItem
sessions[].createdAtrequiredstring (date-time)
sessions[].currentrequiredboolean
sessions[].deviceLabelrequiredstring
sessions[].idrequiredstring
sessions[].lastSeenAtrequiredstring (date-time)
Terminal window
# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/console/me/sessions' \
-H 'X-CSRF-Token: <csrf-token>' \
-H 'Accept: application/json' \
-b 'outpost_console=<console-session>'

POST /api/v1/console/me/sessions/revoke-all

Section titled “POST /api/v1/console/me/sessions/revoke-all”

POSTshared facehosteditmspremote

Source: [object Object]

revokeAllMySessions signs you out everywhere, this browser included, and unpairs every TV display you activated.

StatusBodyDescription
204NoneSuccess, with no body.
Terminal window
# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X POST 'https://depot.example.com/api/v1/console/me/sessions/revoke-all' \
-H 'X-CSRF-Token: <csrf-token>' \
-b 'outpost_console=<console-session>'

Content is licensed CC BY 4.0. Code samples are MIT. Outpost and the Outpost mark are trademarks of Outpost Business Solutions, PBC and are not covered by either license.