Skip to content

API reference

Sites

The Site object

A site: its details, a count of its screens by state, and the screens linked to it.

Attributes

  • siteobjectOptional
    Show child attributesHide child attributes
    • keystringOptional

      The brand code.

    • namestringOptional
  • summaryobjectOptional

    A site’s screens by state. A stopped screen is also counted online or offline.

    Show child attributesHide child attributes
    • keystringOptionalNullable

      The site code; null for the row of screens linked to no site.

    • namestringOptionalNullable
    • screensintegerOptional
    • onlineintegerOptional
    • offlineintegerOptional
    • stoppedintegerOptional
    • playingintegerOptional

      Online screens that are not stopped and last reported showing an item.

    • uptimeobjectOptional

      The site’s screens’ last 30 days added up (up seconds over counted seconds, never an average of the screens’ figures). Null fractions where no day was counted.

      Show child attributesHide child attributes
      • last30dnumberOptionalNullable
      • last30dExSitePowernumberOptionalNullable

        With the seconds lost to the site’s power left out of both sides.

      • trendobjectOptional

        Uptime a day at a time: 30 days, oldest first, each the up seconds over the counted seconds of that day, cut (never rounded up) to four places; null where nothing was counted. On a screen in a paged list, on a site in the list of sites, and on an uptime answer for the default span.

        Show child attributesHide child attributes
        • tostring (date)Optional

          The last of the 30 days.

        • daysarray of numbersOptional
    • grafanaUrlstringOptionalNullable

      Opens the site’s dashboard in the organisation’s hosted Grafana, signed in by a hand-off from the viewer. Null unless hosted dashboards are set up, and for the row with no site.

  • screensarray of objectsOptional
    Show child attributesHide child attributes
    • idstring (uuid)Optional
    • namestringOptional
    • widthintegerOptional

      The screen’s pixels; 0 until known.

    • heightintegerOptional
    • timezonestringOptional
    • appVersionstringOptional
    • onlinebooleanOptional
    • lastSeenAtstring (date-time)OptionalNullable
    • stoppedbooleanOptional
    • stopShowstringOptional

      This screen’s own choice of what it shows while stopped; same follows the organisation’s.

      Possible valuessameblacklogoimagevideo

    • siteStopShowstringOptional

      The choice of the screen’s site (same follows the choice for all screens); empty when the screen has no site.

      Possible valuessameblacklogoimage

    • stopShowFromstringOptional

      Where what the screen shows while stopped comes from: its own choice (screen), its site’s (site) or the choice for all screens (org).

      Possible valuesscreensiteorg

    • unassignedbooleanOptional

      True for a screen that joined with an install key and no owner has named yet.

    • windowobjectOptionalNullable

      The window the screen plays in; null is the whole screen, and always null on a group and on an unassigned screen.

      Show child attributesHide child attributes
      • profileobjectOptional

        The panel profile the window comes from.

        Show child attributesHide child attributes
        • idstringOptional
        • namestringOptional
      • xintegerOptional
      • yintegerOptional
      • wintegerOptional
      • hintegerOptional
      • rotationintegerOptional

        Possible values090180270

      • placeWintegerOptional
      • placeHintegerOptional
    • framesobjectOptional

      A screen’s frames, always present: an empty list on a plain screen, version 0 on a group and on an unassigned screen. A booking can name a frame as it names a screen.

      Show child attributesHide child attributes
      • versionintegerOptional

        Send it back to change the frames.

      • framesarray of objectsOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • xintegerOptional
        • yintegerOptional
        • wintegerOptional
        • hintegerOptional
        • layerintegerOptional
        • soundbooleanOptional
    • orgStoppedbooleanOptional

      True while every screen is stopped: the organisation’s own stop is on, or the organisation is halted (orgHalt).

    • transitionstringOptional

      This screen’s own change between ads; same follows the organisation’s.

      Possible valuessamecutfade

    • h265booleanOptional

      The screen reported it plays H.265.

    • html5booleanOptional

      The screen reported it plays HTML5 packages.

    • decodeAtstring (date-time)OptionalNullable

      When the screen’s reported decoders last changed; null until it has reported.

    • decodearray of objectsOptionalNullable

      What the screen says it decodes, as the server kept it: for each codec and frame rate, the largest picture it plays smoothly. null until it has reported; an empty list is a screen that reported and decodes none (H.264 still plays where the list holds no H.264). The screen’s report is untrusted: entries outside the bounds are dropped.

      Show child attributesHide child attributes
      • codecstringOptional

        Possible valuesh264h265vp9av1

      • maxSideintegerOptional

        The longest side, in pixels.

      • maxPixelsinteger (int64)Optional

        Width times height, in pixels.

      • fpsintegerOptional

        The frame-rate tier this entry covers.

        Possible values3060

    • cantPlayarray of objectsOptional

      The files of this screen’s live bookings that it can’t play, and why. Empty when it plays them all. reason is no_codec (codec is the one it lacks), too_big (maxWidth and maxHeight are the largest picture it decodes for the codec), too_fast (maxFps is its highest frame rate), no_html5 (detail is why HTML5 is off) or no_report (the screen hasn’t said what it plays).

      Show child attributesHide child attributes
      • namestringOptional

        The booking’s name.

      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • stopVideoCantPlayobjectOptional

      Present when this screen is meant to show a stop video it can’t play: it shows black instead. name is stop video; reason and the rest are as in cantPlay.

      Show child attributesHide child attributes
      • namestringOptional
      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • html5OffstringOptional

      Why HTML5 is off on this screen, when it said: the player is starting (starting), the player hasn’t started it (shell_not_ready), the network lock isn’t confirmed (net_jail) or sound can’t be kept off (mute_unconfirmed). Empty when HTML5 is on or no cause was given.

      Possible valuesstartingshell_not_readynet_jailmute_unconfirmed

    • orgHaltstringOptional

      Why the organisation’s screens are halted and black: read_only (the account is read-only; they start again when it is active) or disabled (disabled, or scheduled for deletion). Empty when they are not.

      Possible valuesread_onlydisabled

    • hardwareobjectOptional

      What the screen says it is (its own claim, never proof). tpm is true when it reported a TPM endorsement key; the key itself is never shown.

      Show child attributesHide child attributes
      • manufacturerstringOptional
      • modelstringOptional
      • serialstringOptional
      • tpmbooleanOptional
      • serialSharedbooleanOptional

        True when many PCs report this serial (a placeholder this organisation’s own screens show, or one staff confirmed). It identifies none of them, so the screen gets no “looks like” by serial. Omitted when false.

    • enrolledViaobjectOptionalNullable

      The install key the screen joined with; null for a screen added with a code. name is shown only to a caller with the Screens write permission, and never to staff acting as the organisation.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
    • enrolledAtstring (date-time)Optional

      When the screen joined (paired or enrolled). It never changes; the unassigned pool is listed in this order.

    • opencrsRefstringOptionalNullable

      The OpenCRS screen this screen is the face of, or null.

    • looksLikeCountintegerOptional

      How many of the organisation’s other screens (inside the caller’s scope) may be this same machine: the same serial and maker, or the same TPM key. Only an unassigned screen and a set-up one are ever paired: two unassigned screens never count each other. Lists carry the count; one screen’s own view also carries looksLike.

    • looksLikearray of objectsOptional

      Only in one screen’s own view (GET /devices/{id} and the answers to a change): the first 20 screens it may be the same machine as, in id order. looksLikeCount is the total; when there are more, looksLikeNext is the cursor to pass to GET /devices/{id}/looks-like as after.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • whystringOptional

        What the match rests on. Both are what the PC itself reported (its serial and maker, or its TPM key hash): a claim, not proof. Check the install key and the time it joined before you replace a screen with it.

        Possible valuesserialtpm

    • looksLikeNextstringOptional

      Only in one screen’s own view, and only when looksLike is not the whole list: the after for GET /devices/{id}/looks-like.

    • possibleCopybooleanOptional

      True when the machine’s identity changed since it enrolled in a way that looks like its files were copied to another machine. An owner clears it with cloneChecked: true.

    • copyProvenbooleanOptional

      True when Mestra has found that this screen’s identity is in use on another PC. A replace clears it, and so does the owner saying it is not a copy (cloneChecked).

    • keyCheckobjectOptionalNullable

      A PC set up from a provisioning package plays nothing until its check that Windows’ readable copy of the install key is gone has passed. state is checking, failed (the check could not finish; reason says why, and it tries again by itself) or exposed (it proved a readable copy of the key: revoke the key; reason names the places, with any piece of the key in a name masked). since is when the hold was first seen. Null when the screen is not held. checking and failed, and a failure’s reason, are the PC’s own report on its heartbeat: Mestra bounds and cleans the text but cannot check it, and a held PC is kept inert by its own agent (it is an unassigned pool row either way, which gets no content, commands or credentials). exposed is Mestra’s own mark, set only from a report the server verified against the key the screen joined with.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuescheckingfailedexposed

      • reasonstringOptional
      • sincestring (date-time)OptionalNullable
    • siteCodestringOptional

      The code of the site the screen is linked to; empty when it is not linked.

    • kindstringOptional

      single is a PC; group is a screen group: one screen made of several, with no PC of its own.

      Possible valuessinglegroup

    • groupobjectOptional

      On a member of a group (when the group is in your scope): which group and the member’s place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
    • membersarray of objectsOptional

      On a group: its screens, by place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
      • onlinebooleanOptional
    • layoutobjectOptional

      On a group: its rows and columns, the gap and size you gave, the canvas that comes to, and the version to send with a change.

      Show child attributesHide child attributes
      • rowsintegerOptional
      • colsintegerOptional
      • bezelMmnumberOptionalNullable
      • diagInnumberOptionalNullable
      • canvasWintegerOptional
      • canvasHintegerOptional
      • gapPxintegerOptional
      • cellWintegerOptional
      • cellHintegerOptional
      • placedbooleanOptional
      • placingbooleanOptional
      • versionintegerOptional
      • identifyUntilstring (date-time)OptionalNullable
    • lookbooleanOptional

      The screen needs a look: it last showed something other than what it was told to, or it has several displays and Mestra uses one.

    • syncStatestringOptional

      On a placed group, in a paged list only: whether its screens are in step.

      Possible valuesplacingin_stepout_of_stepunknown

    • syncLatearray of integersOptional

      On a group that is out of step, in a paged list only: the positions of the members the reasons name, in order.

    • displayobjectOptionalNullable

      What the PC said about its displays: how many, the primary and whole desktop size, notSpanned (more than one display and Mestra shows on one), spanned (the graphics driver joins them into one) and sizeChanged (the size before its last change); null from a group and a PC that has not said.

      Show child attributesHide child attributes
      • monitorsintegerOptional
      • primaryWintegerOptional
      • primaryHintegerOptional
      • virtualWintegerOptional
      • virtualHintegerOptional
      • notSpannedbooleanOptional
      • spannedbooleanOptional
      • sizeChangedobjectOptionalNullable
        Show child attributesHide child attributes
        • fromWintegerOptional
        • fromHintegerOptional
        • toWintegerOptional
        • toHintegerOptional
    • soundstringOptionalNullable

      This screen’s own sound setting; null follows its site.

      Possible valuesonoffnull

    • panelVolumeintegerOptionalNullable

      This screen’s own panel volume; null follows its site.

    • hoursarray of valuesOptionalNullable

      This screen’s own on and off times; null follows its site.

    • brightnessarray of valuesOptionalNullable

      This screen’s own brightness times; null follows its site.

    • locationobjectOptionalNullable

      This screen’s own place; null follows its site.

      Show child attributesHide child attributes
      • latnumberOptional
      • lonnumberOptional
      • namestringOptional
      • addressstringOptional
      • citystringOptional
      • statestringOptional
      • postcodestringOptional
    • siteobjectOptionalNullable

      The site the screen is linked to; null when it has none.

      Show child attributesHide child attributes
      • keystringOptional

        The brand code.

      • namestringOptional
    • nowobjectOptional

      What the screen is showing, from its last report. While the screen or the organisation is stopped, state is stopped and entry is null, whatever the screen last said. off means its panel is switched off. entry is null when the screen isn’t showing an item or the item has been deleted.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuesplayingwaitingpairingstoppedoffunknown

      • entryobjectOptionalNullable
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

      • sincestring (date-time)OptionalNullable
    • nextobjectOptionalNullable

      The item the screen shows after this one. Null when the screen is stopped or has not said.

      Show child attributesHide child attributes
      • entryobjectOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

    • lastShotobjectOptional

      On a page of the screens list, for a screen with nothing booked now or next: its newest screenshot that has a small preview. Left out otherwise. thumb is the preview’s address, which holds the shot’s id and never changes.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • thumbstringOptional
      • takenAtstring (date-time)Optional
    • healthobjectOptional

      online is the live check (the screen called within the last 3 minutes). presence is the state the webhooks follow, moved by the screen’s report and a once-a-minute sweep, so the two can differ for up to a minute.

      Show child attributesHide child attributes
      • onlinebooleanOptional
      • presencestringOptional

        Possible valuesonlineoffline

      • presenceSincestring (date-time)OptionalNullable
      • lastSeenAtstring (date-time)OptionalNullable
      • appVersionstringOptional
      • cacheBytesinteger (int64)OptionalNullable

        The size of the screen’s file cache; null until it reports.

      • issueobjectOptional

        The screen’s health line: what is wrong, or that it fixed itself, and what to do about it.

        Show child attributesHide child attributes
        • pillstringOptional

          Possible valuesHealthyFixed itselfNeeds a lookNeeds a visitOffline

        • titlestringOptional
        • fixstringOptional
        • sincestring (date-time)OptionalNullable

          When the fault began, or when it fixed itself.

        • codestringOptional
      • uptimeobjectOptional

        The screen’s last 30 days (its own days, to today) from the days Mestra has signed. Null fractions where no day was counted.

        Show child attributesHide child attributes
        • last30dnumberOptionalNullable
        • last30dExSitePowernumberOptionalNullable

          With the seconds lost to the site’s power left out of both sides.

        • trendobjectOptional

          Uptime a day at a time: 30 days, oldest first, each the up seconds over the counted seconds of that day, cut (never rounded up) to four places; null where nothing was counted. On a screen in a paged list, on a site in the list of sites, and on an uptime answer for the default span.

          Show child attributesHide child attributes
          • tostring (date)Optional

            The last of the 30 days.

          • daysarray of numbersOptional
        • todayobjectOptional

          On a page of the screens list: today so far in the screen’s zone, from the hours it has sealed since midnight. Always partial. It is not in trend, last30d or any signed day. Left out until an hour has been sealed today.

          Show child attributesHide child attributes
          • upnumberOptionalNullable

            Up seconds over counted seconds of those hours, cut (never rounded up) to four places.

          • hoursintegerOptional

            The sealed hours it rests on.

          • partialbooleanOptional
      • lastMismatchobjectOptionalNullable

        The last time the screen found a file that failed its check; entries are the entry ids (or stopshow for the stopped picture). Null when it never has.

        Show child attributesHide child attributes
        • atstring (date-time)Optional
        • entriesarray of stringsOptional
      • diagobjectOptionalNullable

        What the screen’s PC last reported about itself. Null for a group and for a screen that has not reported. Text the device wrote is not shown.

        Show child attributesHide child attributes
        • reportedAtstring (date-time)Optional
        • diskFreeBytesinteger (int64)OptionalNullable
        • diskTotalBytesinteger (int64)OptionalNullable
        • memTotalBytesinteger (int64)OptionalNullable
        • memAvailBytesinteger (int64)OptionalNullable
        • playerRamBytesinteger (int64)OptionalNullable

          The memory the player uses.

        • tempCnumberOptionalNullable

          The PC’s temperature in degrees Celsius.

        • clockOffsetMsintegerOptionalNullable

          How far the PC’s clock is from the server’s, in milliseconds.

        • bootedAtstring (date-time)OptionalNullable
        • shellUpbooleanOptional

          Whether the player’s shell is running.

List all sites

PermissionScreens · Read

Any member’s session (viewer, editor or owner), or a key with the Screens permission. A site is a brand: the site a screen is linked to. Lists each site with at least one of your Mestra screens, by name, with counts over the screens a key can see, then one row with a null key for screens linked to no site (left out when there are none). online and offline split the screens by the live 3-minute check; stopped counts screens stopped on their own or with the organisation (a stopped screen is also online or offline); playing counts online screens that are not stopped and last reported showing an item.

Returns

The sites.

A list of objects, each with:

  • keystringOptionalNullable

    The site code; null for the row of screens linked to no site.

  • namestringOptionalNullable
  • screensintegerOptional
  • onlineintegerOptional
  • offlineintegerOptional
  • stoppedintegerOptional
  • playingintegerOptional

    Online screens that are not stopped and last reported showing an item.

  • uptimeobjectOptional

    The site’s screens’ last 30 days added up (up seconds over counted seconds, never an average of the screens’ figures). Null fractions where no day was counted.

    Show child attributesHide child attributes
    • last30dnumberOptionalNullable
    • last30dExSitePowernumberOptionalNullable

      With the seconds lost to the site’s power left out of both sides.

    • trendobjectOptional

      Uptime a day at a time: 30 days, oldest first, each the up seconds over the counted seconds of that day, cut (never rounded up) to four places; null where nothing was counted. On a screen in a paged list, on a site in the list of sites, and on an uptime answer for the default span.

      Show child attributesHide child attributes
      • tostring (date)Optional

        The last of the 30 days.

      • daysarray of numbersOptional
  • grafanaUrlstringOptionalNullable

    Opens the site’s dashboard in the organisation’s hosted Grafana, signed in by a hand-off from the viewer. Null unless hosted dashboards are set up, and for the row with no site.

Errors

StatusCodeMeaning
401invalid_token

The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.

403wrong_key

wrong_key: the key lacks the Screens permission this call needs.

404not_connected

not_connected.

409api_offintegration_off

api_off (an owner hasn’t turned the API on), or integration_off (Mestra screens are off).

501

The player is not available on this server.

Retrieve a site

PermissionScreens · Read

Any member’s session (viewer, editor or owner), or a key with the Screens permission. One site: its summary, as in the list, and its screens, each as in the screens list. A key limited to some screens sees and counts only those.

Path parameters

  • sitestringRequired

    The brand code.

Returns

The site.

Returns the Site object.

Errors

StatusCodeMeaning
401invalid_token

The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.

403wrong_key

wrong_key: the key lacks the Screens permission this call needs.

404unknown_sitenot_connected

unknown_site (no screen in your scope is linked to that site, or there is no such site), or not_connected.

409api_offintegration_off

api_off (an owner hasn’t turned the API on), or integration_off (Mestra screens are off).

501

The player is not available on this server.

Create a site

PermissionScreens · Write

Needs the Screens write permission and an editor. Makes a site for screens: the same record as a brand in Mestra, with a name and a code.

Body parameters

  • codestringRequired
  • namestringRequired

Returns

The site.

An object with:

  • codestringOptional
  • namestringOptional

Errors

StatusCodeMeaning
400

The name or the key isn’t acceptable.

401invalid_token

The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.

403wrong_keyplan_refused

wrong_key (the key or role can’t do this), a key limited to some screens, or plan_refused.

404not_connected

not_connected.

409api_offintegration_off

The code is taken, or api_off or integration_off.

Retrieve a site's times, brightness and sound

PermissionScreens · Read

Needs the Screens read permission and an owner. A site is a brand’s code that Mestra screens are linked to. Returns its time zone, on and off times, brightness steps, at-screen setting, sound, panel volume and location (null means not chosen) and the screens linked to it. A screen’s panel link is not shown. A key limited to some screens gets 403 screens_limited unless it holds every screen linked to the site.

Path parameters

  • sitestringRequired

    A site code with at least one Mestra screen linked to it (URL-encoded).

Returns

The site’s settings and the screens linked to it.

An object with:

  • timezonestringOptionalNullable
  • hoursarray of valuesOptionalNullable

    On intervals in the screen’s zone. An empty list (or none) means no hours: Mestra won’t turn the panel on or off, and the page plays.

  • brightnessarray of valuesOptionalNullable

    Brightness steps; each holds until the next, wrapping the day. An empty list never sets brightness.

  • atScreenstringOptionalNullable

    Possible valuesrestoreleavenull

  • soundstringOptionalNullable

    null is not chosen, which plays muted.

    Possible valuesonoffnull

  • panelVolumeintegerOptionalNullable
  • locationobjectOptionalNullable

    Where the site is; null is not set.

    Show child attributesHide child attributes
    • latnumberOptional
    • lonnumberOptional
    • namestringOptional
    • addressstringOptional
    • citystringOptional
    • statestringOptional
    • postcodestringOptional
  • devicesarray of objectsOptional

    The Mestra screens linked to the site.

    Show child attributesHide child attributes
    • idstring (uuid)Optional
    • namestringOptional
    • widthintegerOptional

      The screen’s pixels; 0 until known.

    • heightintegerOptional
    • timezonestringOptional
    • appVersionstringOptional
    • onlinebooleanOptional
    • lastSeenAtstring (date-time)OptionalNullable
    • stoppedbooleanOptional
    • stopShowstringOptional

      This screen’s own choice of what it shows while stopped; same follows the organisation’s.

      Possible valuessameblacklogoimagevideo

    • siteStopShowstringOptional

      The choice of the screen’s site (same follows the choice for all screens); empty when the screen has no site.

      Possible valuessameblacklogoimage

    • stopShowFromstringOptional

      Where what the screen shows while stopped comes from: its own choice (screen), its site’s (site) or the choice for all screens (org).

      Possible valuesscreensiteorg

    • unassignedbooleanOptional

      True for a screen that joined with an install key and no owner has named yet.

    • windowobjectOptionalNullable

      The window the screen plays in; null is the whole screen, and always null on a group and on an unassigned screen.

      Show child attributesHide child attributes
      • profileobjectOptional

        The panel profile the window comes from.

        Show child attributesHide child attributes
        • idstringOptional
        • namestringOptional
      • xintegerOptional
      • yintegerOptional
      • wintegerOptional
      • hintegerOptional
      • rotationintegerOptional

        Possible values090180270

      • placeWintegerOptional
      • placeHintegerOptional
    • framesobjectOptional

      A screen’s frames, always present: an empty list on a plain screen, version 0 on a group and on an unassigned screen. A booking can name a frame as it names a screen.

      Show child attributesHide child attributes
      • versionintegerOptional

        Send it back to change the frames.

      • framesarray of objectsOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • xintegerOptional
        • yintegerOptional
        • wintegerOptional
        • hintegerOptional
        • layerintegerOptional
        • soundbooleanOptional
    • orgStoppedbooleanOptional

      True while every screen is stopped: the organisation’s own stop is on, or the organisation is halted (orgHalt).

    • transitionstringOptional

      This screen’s own change between ads; same follows the organisation’s.

      Possible valuessamecutfade

    • h265booleanOptional

      The screen reported it plays H.265.

    • html5booleanOptional

      The screen reported it plays HTML5 packages.

    • decodeAtstring (date-time)OptionalNullable

      When the screen’s reported decoders last changed; null until it has reported.

    • decodearray of objectsOptionalNullable

      What the screen says it decodes, as the server kept it: for each codec and frame rate, the largest picture it plays smoothly. null until it has reported; an empty list is a screen that reported and decodes none (H.264 still plays where the list holds no H.264). The screen’s report is untrusted: entries outside the bounds are dropped.

      Show child attributesHide child attributes
      • codecstringOptional

        Possible valuesh264h265vp9av1

      • maxSideintegerOptional

        The longest side, in pixels.

      • maxPixelsinteger (int64)Optional

        Width times height, in pixels.

      • fpsintegerOptional

        The frame-rate tier this entry covers.

        Possible values3060

    • cantPlayarray of objectsOptional

      The files of this screen’s live bookings that it can’t play, and why. Empty when it plays them all. reason is no_codec (codec is the one it lacks), too_big (maxWidth and maxHeight are the largest picture it decodes for the codec), too_fast (maxFps is its highest frame rate), no_html5 (detail is why HTML5 is off) or no_report (the screen hasn’t said what it plays).

      Show child attributesHide child attributes
      • namestringOptional

        The booking’s name.

      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • stopVideoCantPlayobjectOptional

      Present when this screen is meant to show a stop video it can’t play: it shows black instead. name is stop video; reason and the rest are as in cantPlay.

      Show child attributesHide child attributes
      • namestringOptional
      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • html5OffstringOptional

      Why HTML5 is off on this screen, when it said: the player is starting (starting), the player hasn’t started it (shell_not_ready), the network lock isn’t confirmed (net_jail) or sound can’t be kept off (mute_unconfirmed). Empty when HTML5 is on or no cause was given.

      Possible valuesstartingshell_not_readynet_jailmute_unconfirmed

    • orgHaltstringOptional

      Why the organisation’s screens are halted and black: read_only (the account is read-only; they start again when it is active) or disabled (disabled, or scheduled for deletion). Empty when they are not.

      Possible valuesread_onlydisabled

    • hardwareobjectOptional

      What the screen says it is (its own claim, never proof). tpm is true when it reported a TPM endorsement key; the key itself is never shown.

      Show child attributesHide child attributes
      • manufacturerstringOptional
      • modelstringOptional
      • serialstringOptional
      • tpmbooleanOptional
      • serialSharedbooleanOptional

        True when many PCs report this serial (a placeholder this organisation’s own screens show, or one staff confirmed). It identifies none of them, so the screen gets no “looks like” by serial. Omitted when false.

    • enrolledViaobjectOptionalNullable

      The install key the screen joined with; null for a screen added with a code. name is shown only to a caller with the Screens write permission, and never to staff acting as the organisation.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
    • enrolledAtstring (date-time)Optional

      When the screen joined (paired or enrolled). It never changes; the unassigned pool is listed in this order.

    • opencrsRefstringOptionalNullable

      The OpenCRS screen this screen is the face of, or null.

    • looksLikeCountintegerOptional

      How many of the organisation’s other screens (inside the caller’s scope) may be this same machine: the same serial and maker, or the same TPM key. Only an unassigned screen and a set-up one are ever paired: two unassigned screens never count each other. Lists carry the count; one screen’s own view also carries looksLike.

    • looksLikearray of objectsOptional

      Only in one screen’s own view (GET /devices/{id} and the answers to a change): the first 20 screens it may be the same machine as, in id order. looksLikeCount is the total; when there are more, looksLikeNext is the cursor to pass to GET /devices/{id}/looks-like as after.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • whystringOptional

        What the match rests on. Both are what the PC itself reported (its serial and maker, or its TPM key hash): a claim, not proof. Check the install key and the time it joined before you replace a screen with it.

        Possible valuesserialtpm

    • looksLikeNextstringOptional

      Only in one screen’s own view, and only when looksLike is not the whole list: the after for GET /devices/{id}/looks-like.

    • possibleCopybooleanOptional

      True when the machine’s identity changed since it enrolled in a way that looks like its files were copied to another machine. An owner clears it with cloneChecked: true.

    • copyProvenbooleanOptional

      True when Mestra has found that this screen’s identity is in use on another PC. A replace clears it, and so does the owner saying it is not a copy (cloneChecked).

    • keyCheckobjectOptionalNullable

      A PC set up from a provisioning package plays nothing until its check that Windows’ readable copy of the install key is gone has passed. state is checking, failed (the check could not finish; reason says why, and it tries again by itself) or exposed (it proved a readable copy of the key: revoke the key; reason names the places, with any piece of the key in a name masked). since is when the hold was first seen. Null when the screen is not held. checking and failed, and a failure’s reason, are the PC’s own report on its heartbeat: Mestra bounds and cleans the text but cannot check it, and a held PC is kept inert by its own agent (it is an unassigned pool row either way, which gets no content, commands or credentials). exposed is Mestra’s own mark, set only from a report the server verified against the key the screen joined with.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuescheckingfailedexposed

      • reasonstringOptional
      • sincestring (date-time)OptionalNullable
    • siteCodestringOptional

      The code of the site the screen is linked to; empty when it is not linked.

    • kindstringOptional

      single is a PC; group is a screen group: one screen made of several, with no PC of its own.

      Possible valuessinglegroup

    • groupobjectOptional

      On a member of a group (when the group is in your scope): which group and the member’s place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
    • membersarray of objectsOptional

      On a group: its screens, by place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
      • onlinebooleanOptional
    • layoutobjectOptional

      On a group: its rows and columns, the gap and size you gave, the canvas that comes to, and the version to send with a change.

      Show child attributesHide child attributes
      • rowsintegerOptional
      • colsintegerOptional
      • bezelMmnumberOptionalNullable
      • diagInnumberOptionalNullable
      • canvasWintegerOptional
      • canvasHintegerOptional
      • gapPxintegerOptional
      • cellWintegerOptional
      • cellHintegerOptional
      • placedbooleanOptional
      • placingbooleanOptional
      • versionintegerOptional
      • identifyUntilstring (date-time)OptionalNullable
    • lookbooleanOptional

      The screen needs a look: it last showed something other than what it was told to, or it has several displays and Mestra uses one.

    • syncStatestringOptional

      On a placed group, in a paged list only: whether its screens are in step.

      Possible valuesplacingin_stepout_of_stepunknown

    • syncLatearray of integersOptional

      On a group that is out of step, in a paged list only: the positions of the members the reasons name, in order.

    • displayobjectOptionalNullable

      What the PC said about its displays: how many, the primary and whole desktop size, notSpanned (more than one display and Mestra shows on one), spanned (the graphics driver joins them into one) and sizeChanged (the size before its last change); null from a group and a PC that has not said.

      Show child attributesHide child attributes
      • monitorsintegerOptional
      • primaryWintegerOptional
      • primaryHintegerOptional
      • virtualWintegerOptional
      • virtualHintegerOptional
      • notSpannedbooleanOptional
      • spannedbooleanOptional
      • sizeChangedobjectOptionalNullable
        Show child attributesHide child attributes
        • fromWintegerOptional
        • fromHintegerOptional
        • toWintegerOptional
        • toHintegerOptional
    • soundstringOptionalNullable

      This screen’s own sound setting; null follows its site.

      Possible valuesonoffnull

    • panelVolumeintegerOptionalNullable

      This screen’s own panel volume; null follows its site.

    • hoursarray of valuesOptionalNullable

      This screen’s own on and off times; null follows its site.

    • brightnessarray of valuesOptionalNullable

      This screen’s own brightness times; null follows its site.

    • locationobjectOptionalNullable

      This screen’s own place; null follows its site.

      Show child attributesHide child attributes
      • latnumberOptional
      • lonnumberOptional
      • namestringOptional
      • addressstringOptional
      • citystringOptional
      • statestringOptional
      • postcodestringOptional
    • siteobjectOptionalNullable

      The site the screen is linked to; null when it has none.

      Show child attributesHide child attributes
      • keystringOptional

        The brand code.

      • namestringOptional
    • nowobjectOptional

      What the screen is showing, from its last report. While the screen or the organisation is stopped, state is stopped and entry is null, whatever the screen last said. off means its panel is switched off. entry is null when the screen isn’t showing an item or the item has been deleted.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuesplayingwaitingpairingstoppedoffunknown

      • entryobjectOptionalNullable
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

      • sincestring (date-time)OptionalNullable
    • nextobjectOptionalNullable

      The item the screen shows after this one. Null when the screen is stopped or has not said.

      Show child attributesHide child attributes
      • entryobjectOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

    • lastShotobjectOptional

      On a page of the screens list, for a screen with nothing booked now or next: its newest screenshot that has a small preview. Left out otherwise. thumb is the preview’s address, which holds the shot’s id and never changes.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • thumbstringOptional
      • takenAtstring (date-time)Optional
    • healthobjectOptional

      online is the live check (the screen called within the last 3 minutes). presence is the state the webhooks follow, moved by the screen’s report and a once-a-minute sweep, so the two can differ for up to a minute.

      Show child attributesHide child attributes
      • onlinebooleanOptional
      • presencestringOptional

        Possible valuesonlineoffline

      • presenceSincestring (date-time)OptionalNullable
      • lastSeenAtstring (date-time)OptionalNullable
      • appVersionstringOptional
      • cacheBytesinteger (int64)OptionalNullable

        The size of the screen’s file cache; null until it reports.

      • issueobjectOptional

        The screen’s health line: what is wrong, or that it fixed itself, and what to do about it.

        Show child attributesHide child attributes
        • pillstringOptional

          Possible valuesHealthyFixed itselfNeeds a lookNeeds a visitOffline

        • titlestringOptional
        • fixstringOptional
        • sincestring (date-time)OptionalNullable

          When the fault began, or when it fixed itself.

        • codestringOptional
      • uptimeobjectOptional

        The screen’s last 30 days (its own days, to today) from the days Mestra has signed. Null fractions where no day was counted.

        Show child attributesHide child attributes
        • last30dnumberOptionalNullable
        • last30dExSitePowernumberOptionalNullable

          With the seconds lost to the site’s power left out of both sides.

        • trendobjectOptional

          Uptime a day at a time: 30 days, oldest first, each the up seconds over the counted seconds of that day, cut (never rounded up) to four places; null where nothing was counted. On a screen in a paged list, on a site in the list of sites, and on an uptime answer for the default span.

          Show child attributesHide child attributes
          • tostring (date)Optional

            The last of the 30 days.

          • daysarray of numbersOptional
        • todayobjectOptional

          On a page of the screens list: today so far in the screen’s zone, from the hours it has sealed since midnight. Always partial. It is not in trend, last30d or any signed day. Left out until an hour has been sealed today.

          Show child attributesHide child attributes
          • upnumberOptionalNullable

            Up seconds over counted seconds of those hours, cut (never rounded up) to four places.

          • hoursintegerOptional

            The sealed hours it rests on.

          • partialbooleanOptional
      • lastMismatchobjectOptionalNullable

        The last time the screen found a file that failed its check; entries are the entry ids (or stopshow for the stopped picture). Null when it never has.

        Show child attributesHide child attributes
        • atstring (date-time)Optional
        • entriesarray of stringsOptional
      • diagobjectOptionalNullable

        What the screen’s PC last reported about itself. Null for a group and for a screen that has not reported. Text the device wrote is not shown.

        Show child attributesHide child attributes
        • reportedAtstring (date-time)Optional
        • diskFreeBytesinteger (int64)OptionalNullable
        • diskTotalBytesinteger (int64)OptionalNullable
        • memTotalBytesinteger (int64)OptionalNullable
        • memAvailBytesinteger (int64)OptionalNullable
        • playerRamBytesinteger (int64)OptionalNullable

          The memory the player uses.

        • tempCnumberOptionalNullable

          The PC’s temperature in degrees Celsius.

        • clockOffsetMsintegerOptionalNullable

          How far the PC’s clock is from the server’s, in milliseconds.

        • bootedAtstring (date-time)OptionalNullable
        • shellUpbooleanOptional

          Whether the player’s shell is running.

Errors

StatusCodeMeaning
401invalid_token

The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.

403wrong_keyscreens_limited

wrong_key, screens_limited, or a role below an owner’s.

404unknown_sitenot_connected

unknown_site (no Mestra screen of the organisation is linked to that site), or not_connected.

409api_offintegration_off

api_off (an owner hasn’t turned the API on), or integration_off.

501

The player is not available on this server.

Update a site's times, brightness or sound

PermissionScreens · Write

Needs the Screens write permission and an owner. An absent field is kept; an explicit null clears it; {} changes nothing. Fields: timezone, hours, brightness, atScreen (restore or leave), sound (the string on or off, or null), panelVolume and location (an object, or null to clear). The site’s screens are told at once. A key limited to some screens gets 403 screens_limited unless it holds every screen linked to the site.

Path parameters

  • sitestringRequired

    A site code with at least one Mestra screen linked to it (URL-encoded).

Body parameters

  • timezonestringOptionalNullable

    An IANA zone name, like Australia/Sydney.

  • hoursarray of valuesOptionalNullable

    On intervals in the screen’s zone. An empty list (or none) means no hours: Mestra won’t turn the panel on or off, and the page plays.

  • brightnessarray of valuesOptionalNullable

    Brightness steps; each holds until the next, wrapping the day. An empty list never sets brightness.

  • atScreenstringOptionalNullable

    Possible valuesrestoreleavenull

  • soundstringOptionalNullable

    Sound at the site’s screens. Unset plays muted.

    Possible valuesonoffnull

  • panelVolumeintegerOptionalNullable

    The panel’s own volume; null leaves the panel as set.

  • locationobjectOptionalNullable

    Where the site is; its screens use it unless they have their own. null clears it.

    Show child attributesHide child attributes
    • latnumberOptional
    • lonnumberOptional
    • namestringOptional
    • addressstringOptional
    • citystringOptional
    • statestringOptional
    • postcodestringOptional

Returns

The site as it is now.

An object with:

  • timezonestringOptionalNullable
  • hoursarray of valuesOptionalNullable

    On intervals in the screen’s zone. An empty list (or none) means no hours: Mestra won’t turn the panel on or off, and the page plays.

  • brightnessarray of valuesOptionalNullable

    Brightness steps; each holds until the next, wrapping the day. An empty list never sets brightness.

  • atScreenstringOptionalNullable

    Possible valuesrestoreleavenull

  • soundstringOptionalNullable

    null is not chosen, which plays muted.

    Possible valuesonoffnull

  • panelVolumeintegerOptionalNullable
  • locationobjectOptionalNullable

    Where the site is; null is not set.

    Show child attributesHide child attributes
    • latnumberOptional
    • lonnumberOptional
    • namestringOptional
    • addressstringOptional
    • citystringOptional
    • statestringOptional
    • postcodestringOptional
  • devicesarray of objectsOptional

    The Mestra screens linked to the site.

    Show child attributesHide child attributes
    • idstring (uuid)Optional
    • namestringOptional
    • widthintegerOptional

      The screen’s pixels; 0 until known.

    • heightintegerOptional
    • timezonestringOptional
    • appVersionstringOptional
    • onlinebooleanOptional
    • lastSeenAtstring (date-time)OptionalNullable
    • stoppedbooleanOptional
    • stopShowstringOptional

      This screen’s own choice of what it shows while stopped; same follows the organisation’s.

      Possible valuessameblacklogoimagevideo

    • siteStopShowstringOptional

      The choice of the screen’s site (same follows the choice for all screens); empty when the screen has no site.

      Possible valuessameblacklogoimage

    • stopShowFromstringOptional

      Where what the screen shows while stopped comes from: its own choice (screen), its site’s (site) or the choice for all screens (org).

      Possible valuesscreensiteorg

    • unassignedbooleanOptional

      True for a screen that joined with an install key and no owner has named yet.

    • windowobjectOptionalNullable

      The window the screen plays in; null is the whole screen, and always null on a group and on an unassigned screen.

      Show child attributesHide child attributes
      • profileobjectOptional

        The panel profile the window comes from.

        Show child attributesHide child attributes
        • idstringOptional
        • namestringOptional
      • xintegerOptional
      • yintegerOptional
      • wintegerOptional
      • hintegerOptional
      • rotationintegerOptional

        Possible values090180270

      • placeWintegerOptional
      • placeHintegerOptional
    • framesobjectOptional

      A screen’s frames, always present: an empty list on a plain screen, version 0 on a group and on an unassigned screen. A booking can name a frame as it names a screen.

      Show child attributesHide child attributes
      • versionintegerOptional

        Send it back to change the frames.

      • framesarray of objectsOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • xintegerOptional
        • yintegerOptional
        • wintegerOptional
        • hintegerOptional
        • layerintegerOptional
        • soundbooleanOptional
    • orgStoppedbooleanOptional

      True while every screen is stopped: the organisation’s own stop is on, or the organisation is halted (orgHalt).

    • transitionstringOptional

      This screen’s own change between ads; same follows the organisation’s.

      Possible valuessamecutfade

    • h265booleanOptional

      The screen reported it plays H.265.

    • html5booleanOptional

      The screen reported it plays HTML5 packages.

    • decodeAtstring (date-time)OptionalNullable

      When the screen’s reported decoders last changed; null until it has reported.

    • decodearray of objectsOptionalNullable

      What the screen says it decodes, as the server kept it: for each codec and frame rate, the largest picture it plays smoothly. null until it has reported; an empty list is a screen that reported and decodes none (H.264 still plays where the list holds no H.264). The screen’s report is untrusted: entries outside the bounds are dropped.

      Show child attributesHide child attributes
      • codecstringOptional

        Possible valuesh264h265vp9av1

      • maxSideintegerOptional

        The longest side, in pixels.

      • maxPixelsinteger (int64)Optional

        Width times height, in pixels.

      • fpsintegerOptional

        The frame-rate tier this entry covers.

        Possible values3060

    • cantPlayarray of objectsOptional

      The files of this screen’s live bookings that it can’t play, and why. Empty when it plays them all. reason is no_codec (codec is the one it lacks), too_big (maxWidth and maxHeight are the largest picture it decodes for the codec), too_fast (maxFps is its highest frame rate), no_html5 (detail is why HTML5 is off) or no_report (the screen hasn’t said what it plays).

      Show child attributesHide child attributes
      • namestringOptional

        The booking’s name.

      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • stopVideoCantPlayobjectOptional

      Present when this screen is meant to show a stop video it can’t play: it shows black instead. name is stop video; reason and the rest are as in cantPlay.

      Show child attributesHide child attributes
      • namestringOptional
      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • html5OffstringOptional

      Why HTML5 is off on this screen, when it said: the player is starting (starting), the player hasn’t started it (shell_not_ready), the network lock isn’t confirmed (net_jail) or sound can’t be kept off (mute_unconfirmed). Empty when HTML5 is on or no cause was given.

      Possible valuesstartingshell_not_readynet_jailmute_unconfirmed

    • orgHaltstringOptional

      Why the organisation’s screens are halted and black: read_only (the account is read-only; they start again when it is active) or disabled (disabled, or scheduled for deletion). Empty when they are not.

      Possible valuesread_onlydisabled

    • hardwareobjectOptional

      What the screen says it is (its own claim, never proof). tpm is true when it reported a TPM endorsement key; the key itself is never shown.

      Show child attributesHide child attributes
      • manufacturerstringOptional
      • modelstringOptional
      • serialstringOptional
      • tpmbooleanOptional
      • serialSharedbooleanOptional

        True when many PCs report this serial (a placeholder this organisation’s own screens show, or one staff confirmed). It identifies none of them, so the screen gets no “looks like” by serial. Omitted when false.

    • enrolledViaobjectOptionalNullable

      The install key the screen joined with; null for a screen added with a code. name is shown only to a caller with the Screens write permission, and never to staff acting as the organisation.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
    • enrolledAtstring (date-time)Optional

      When the screen joined (paired or enrolled). It never changes; the unassigned pool is listed in this order.

    • opencrsRefstringOptionalNullable

      The OpenCRS screen this screen is the face of, or null.

    • looksLikeCountintegerOptional

      How many of the organisation’s other screens (inside the caller’s scope) may be this same machine: the same serial and maker, or the same TPM key. Only an unassigned screen and a set-up one are ever paired: two unassigned screens never count each other. Lists carry the count; one screen’s own view also carries looksLike.

    • looksLikearray of objectsOptional

      Only in one screen’s own view (GET /devices/{id} and the answers to a change): the first 20 screens it may be the same machine as, in id order. looksLikeCount is the total; when there are more, looksLikeNext is the cursor to pass to GET /devices/{id}/looks-like as after.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • whystringOptional

        What the match rests on. Both are what the PC itself reported (its serial and maker, or its TPM key hash): a claim, not proof. Check the install key and the time it joined before you replace a screen with it.

        Possible valuesserialtpm

    • looksLikeNextstringOptional

      Only in one screen’s own view, and only when looksLike is not the whole list: the after for GET /devices/{id}/looks-like.

    • possibleCopybooleanOptional

      True when the machine’s identity changed since it enrolled in a way that looks like its files were copied to another machine. An owner clears it with cloneChecked: true.

    • copyProvenbooleanOptional

      True when Mestra has found that this screen’s identity is in use on another PC. A replace clears it, and so does the owner saying it is not a copy (cloneChecked).

    • keyCheckobjectOptionalNullable

      A PC set up from a provisioning package plays nothing until its check that Windows’ readable copy of the install key is gone has passed. state is checking, failed (the check could not finish; reason says why, and it tries again by itself) or exposed (it proved a readable copy of the key: revoke the key; reason names the places, with any piece of the key in a name masked). since is when the hold was first seen. Null when the screen is not held. checking and failed, and a failure’s reason, are the PC’s own report on its heartbeat: Mestra bounds and cleans the text but cannot check it, and a held PC is kept inert by its own agent (it is an unassigned pool row either way, which gets no content, commands or credentials). exposed is Mestra’s own mark, set only from a report the server verified against the key the screen joined with.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuescheckingfailedexposed

      • reasonstringOptional
      • sincestring (date-time)OptionalNullable
    • siteCodestringOptional

      The code of the site the screen is linked to; empty when it is not linked.

    • kindstringOptional

      single is a PC; group is a screen group: one screen made of several, with no PC of its own.

      Possible valuessinglegroup

    • groupobjectOptional

      On a member of a group (when the group is in your scope): which group and the member’s place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
    • membersarray of objectsOptional

      On a group: its screens, by place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
      • onlinebooleanOptional
    • layoutobjectOptional

      On a group: its rows and columns, the gap and size you gave, the canvas that comes to, and the version to send with a change.

      Show child attributesHide child attributes
      • rowsintegerOptional
      • colsintegerOptional
      • bezelMmnumberOptionalNullable
      • diagInnumberOptionalNullable
      • canvasWintegerOptional
      • canvasHintegerOptional
      • gapPxintegerOptional
      • cellWintegerOptional
      • cellHintegerOptional
      • placedbooleanOptional
      • placingbooleanOptional
      • versionintegerOptional
      • identifyUntilstring (date-time)OptionalNullable
    • lookbooleanOptional

      The screen needs a look: it last showed something other than what it was told to, or it has several displays and Mestra uses one.

    • syncStatestringOptional

      On a placed group, in a paged list only: whether its screens are in step.

      Possible valuesplacingin_stepout_of_stepunknown

    • syncLatearray of integersOptional

      On a group that is out of step, in a paged list only: the positions of the members the reasons name, in order.

    • displayobjectOptionalNullable

      What the PC said about its displays: how many, the primary and whole desktop size, notSpanned (more than one display and Mestra shows on one), spanned (the graphics driver joins them into one) and sizeChanged (the size before its last change); null from a group and a PC that has not said.

      Show child attributesHide child attributes
      • monitorsintegerOptional
      • primaryWintegerOptional
      • primaryHintegerOptional
      • virtualWintegerOptional
      • virtualHintegerOptional
      • notSpannedbooleanOptional
      • spannedbooleanOptional
      • sizeChangedobjectOptionalNullable
        Show child attributesHide child attributes
        • fromWintegerOptional
        • fromHintegerOptional
        • toWintegerOptional
        • toHintegerOptional
    • soundstringOptionalNullable

      This screen’s own sound setting; null follows its site.

      Possible valuesonoffnull

    • panelVolumeintegerOptionalNullable

      This screen’s own panel volume; null follows its site.

    • hoursarray of valuesOptionalNullable

      This screen’s own on and off times; null follows its site.

    • brightnessarray of valuesOptionalNullable

      This screen’s own brightness times; null follows its site.

    • locationobjectOptionalNullable

      This screen’s own place; null follows its site.

      Show child attributesHide child attributes
      • latnumberOptional
      • lonnumberOptional
      • namestringOptional
      • addressstringOptional
      • citystringOptional
      • statestringOptional
      • postcodestringOptional
    • siteobjectOptionalNullable

      The site the screen is linked to; null when it has none.

      Show child attributesHide child attributes
      • keystringOptional

        The brand code.

      • namestringOptional
    • nowobjectOptional

      What the screen is showing, from its last report. While the screen or the organisation is stopped, state is stopped and entry is null, whatever the screen last said. off means its panel is switched off. entry is null when the screen isn’t showing an item or the item has been deleted.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuesplayingwaitingpairingstoppedoffunknown

      • entryobjectOptionalNullable
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

      • sincestring (date-time)OptionalNullable
    • nextobjectOptionalNullable

      The item the screen shows after this one. Null when the screen is stopped or has not said.

      Show child attributesHide child attributes
      • entryobjectOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

    • lastShotobjectOptional

      On a page of the screens list, for a screen with nothing booked now or next: its newest screenshot that has a small preview. Left out otherwise. thumb is the preview’s address, which holds the shot’s id and never changes.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • thumbstringOptional
      • takenAtstring (date-time)Optional
    • healthobjectOptional

      online is the live check (the screen called within the last 3 minutes). presence is the state the webhooks follow, moved by the screen’s report and a once-a-minute sweep, so the two can differ for up to a minute.

      Show child attributesHide child attributes
      • onlinebooleanOptional
      • presencestringOptional

        Possible valuesonlineoffline

      • presenceSincestring (date-time)OptionalNullable
      • lastSeenAtstring (date-time)OptionalNullable
      • appVersionstringOptional
      • cacheBytesinteger (int64)OptionalNullable

        The size of the screen’s file cache; null until it reports.

      • issueobjectOptional

        The screen’s health line: what is wrong, or that it fixed itself, and what to do about it.

        Show child attributesHide child attributes
        • pillstringOptional

          Possible valuesHealthyFixed itselfNeeds a lookNeeds a visitOffline

        • titlestringOptional
        • fixstringOptional
        • sincestring (date-time)OptionalNullable

          When the fault began, or when it fixed itself.

        • codestringOptional
      • uptimeobjectOptional

        The screen’s last 30 days (its own days, to today) from the days Mestra has signed. Null fractions where no day was counted.

        Show child attributesHide child attributes
        • last30dnumberOptionalNullable
        • last30dExSitePowernumberOptionalNullable

          With the seconds lost to the site’s power left out of both sides.

        • trendobjectOptional

          Uptime a day at a time: 30 days, oldest first, each the up seconds over the counted seconds of that day, cut (never rounded up) to four places; null where nothing was counted. On a screen in a paged list, on a site in the list of sites, and on an uptime answer for the default span.

          Show child attributesHide child attributes
          • tostring (date)Optional

            The last of the 30 days.

          • daysarray of numbersOptional
        • todayobjectOptional

          On a page of the screens list: today so far in the screen’s zone, from the hours it has sealed since midnight. Always partial. It is not in trend, last30d or any signed day. Left out until an hour has been sealed today.

          Show child attributesHide child attributes
          • upnumberOptionalNullable

            Up seconds over counted seconds of those hours, cut (never rounded up) to four places.

          • hoursintegerOptional

            The sealed hours it rests on.

          • partialbooleanOptional
      • lastMismatchobjectOptionalNullable

        The last time the screen found a file that failed its check; entries are the entry ids (or stopshow for the stopped picture). Null when it never has.

        Show child attributesHide child attributes
        • atstring (date-time)Optional
        • entriesarray of stringsOptional
      • diagobjectOptionalNullable

        What the screen’s PC last reported about itself. Null for a group and for a screen that has not reported. Text the device wrote is not shown.

        Show child attributesHide child attributes
        • reportedAtstring (date-time)Optional
        • diskFreeBytesinteger (int64)OptionalNullable
        • diskTotalBytesinteger (int64)OptionalNullable
        • memTotalBytesinteger (int64)OptionalNullable
        • memAvailBytesinteger (int64)OptionalNullable
        • playerRamBytesinteger (int64)OptionalNullable

          The memory the player uses.

        • tempCnumberOptionalNullable

          The PC’s temperature in degrees Celsius.

        • clockOffsetMsintegerOptionalNullable

          How far the PC’s clock is from the server’s, in milliseconds.

        • bootedAtstring (date-time)OptionalNullable
        • shellUpbooleanOptional

          Whether the player’s shell is running.

Errors

StatusCodeMeaning
400

A setting that is not valid, or not a site setting (with field).

401invalid_token

The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.

403wrong_keyscreens_limited

wrong_key, screens_limited, or a role below an owner’s.

404unknown_sitenot_connected

unknown_site, or not_connected.

409api_offintegration_off

api_off (an owner hasn’t turned the API on), or integration_off.

413

“body exceeds limit (<n> bytes)”.

501

The player is not available on this server.

Update the power of a site's screens

PermissionScreens · Write

Needs the Screens write permission and an owner. power is on, off or schedule, as for one screen, applied to every screen linked to the site now. until must be in the future. A site’s power may be changed a limited number of times an hour (429). A key limited to some screens gets 403 screens_limited unless it holds every screen linked to the site.

Path parameters

  • sitestringRequired

    A site code with at least one Mestra screen linked to it (URL-encoded).

Body parameters

  • powerstringRequired

    Possible valuesonoffschedule

  • untilstring (date-time)Optional

    In the future. Only with on or off; without it the hold lasts until changed.

Returns

The site as it is now.

An object with:

  • timezonestringOptionalNullable
  • hoursarray of valuesOptionalNullable

    On intervals in the screen’s zone. An empty list (or none) means no hours: Mestra won’t turn the panel on or off, and the page plays.

  • brightnessarray of valuesOptionalNullable

    Brightness steps; each holds until the next, wrapping the day. An empty list never sets brightness.

  • atScreenstringOptionalNullable

    Possible valuesrestoreleavenull

  • soundstringOptionalNullable

    null is not chosen, which plays muted.

    Possible valuesonoffnull

  • panelVolumeintegerOptionalNullable
  • locationobjectOptionalNullable

    Where the site is; null is not set.

    Show child attributesHide child attributes
    • latnumberOptional
    • lonnumberOptional
    • namestringOptional
    • addressstringOptional
    • citystringOptional
    • statestringOptional
    • postcodestringOptional
  • devicesarray of objectsOptional

    The Mestra screens linked to the site.

    Show child attributesHide child attributes
    • idstring (uuid)Optional
    • namestringOptional
    • widthintegerOptional

      The screen’s pixels; 0 until known.

    • heightintegerOptional
    • timezonestringOptional
    • appVersionstringOptional
    • onlinebooleanOptional
    • lastSeenAtstring (date-time)OptionalNullable
    • stoppedbooleanOptional
    • stopShowstringOptional

      This screen’s own choice of what it shows while stopped; same follows the organisation’s.

      Possible valuessameblacklogoimagevideo

    • siteStopShowstringOptional

      The choice of the screen’s site (same follows the choice for all screens); empty when the screen has no site.

      Possible valuessameblacklogoimage

    • stopShowFromstringOptional

      Where what the screen shows while stopped comes from: its own choice (screen), its site’s (site) or the choice for all screens (org).

      Possible valuesscreensiteorg

    • unassignedbooleanOptional

      True for a screen that joined with an install key and no owner has named yet.

    • windowobjectOptionalNullable

      The window the screen plays in; null is the whole screen, and always null on a group and on an unassigned screen.

      Show child attributesHide child attributes
      • profileobjectOptional

        The panel profile the window comes from.

        Show child attributesHide child attributes
        • idstringOptional
        • namestringOptional
      • xintegerOptional
      • yintegerOptional
      • wintegerOptional
      • hintegerOptional
      • rotationintegerOptional

        Possible values090180270

      • placeWintegerOptional
      • placeHintegerOptional
    • framesobjectOptional

      A screen’s frames, always present: an empty list on a plain screen, version 0 on a group and on an unassigned screen. A booking can name a frame as it names a screen.

      Show child attributesHide child attributes
      • versionintegerOptional

        Send it back to change the frames.

      • framesarray of objectsOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • xintegerOptional
        • yintegerOptional
        • wintegerOptional
        • hintegerOptional
        • layerintegerOptional
        • soundbooleanOptional
    • orgStoppedbooleanOptional

      True while every screen is stopped: the organisation’s own stop is on, or the organisation is halted (orgHalt).

    • transitionstringOptional

      This screen’s own change between ads; same follows the organisation’s.

      Possible valuessamecutfade

    • h265booleanOptional

      The screen reported it plays H.265.

    • html5booleanOptional

      The screen reported it plays HTML5 packages.

    • decodeAtstring (date-time)OptionalNullable

      When the screen’s reported decoders last changed; null until it has reported.

    • decodearray of objectsOptionalNullable

      What the screen says it decodes, as the server kept it: for each codec and frame rate, the largest picture it plays smoothly. null until it has reported; an empty list is a screen that reported and decodes none (H.264 still plays where the list holds no H.264). The screen’s report is untrusted: entries outside the bounds are dropped.

      Show child attributesHide child attributes
      • codecstringOptional

        Possible valuesh264h265vp9av1

      • maxSideintegerOptional

        The longest side, in pixels.

      • maxPixelsinteger (int64)Optional

        Width times height, in pixels.

      • fpsintegerOptional

        The frame-rate tier this entry covers.

        Possible values3060

    • cantPlayarray of objectsOptional

      The files of this screen’s live bookings that it can’t play, and why. Empty when it plays them all. reason is no_codec (codec is the one it lacks), too_big (maxWidth and maxHeight are the largest picture it decodes for the codec), too_fast (maxFps is its highest frame rate), no_html5 (detail is why HTML5 is off) or no_report (the screen hasn’t said what it plays).

      Show child attributesHide child attributes
      • namestringOptional

        The booking’s name.

      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • stopVideoCantPlayobjectOptional

      Present when this screen is meant to show a stop video it can’t play: it shows black instead. name is stop video; reason and the rest are as in cantPlay.

      Show child attributesHide child attributes
      • namestringOptional
      • reasonstringOptional

        Possible valuesno_codectoo_bigtoo_fastno_html5no_report

      • codecstringOptional

        Possible valuesh264h265vp9av1

      • detailstringOptional
      • maxWidthintegerOptional
      • maxHeightintegerOptional
      • maxFpsintegerOptional
    • html5OffstringOptional

      Why HTML5 is off on this screen, when it said: the player is starting (starting), the player hasn’t started it (shell_not_ready), the network lock isn’t confirmed (net_jail) or sound can’t be kept off (mute_unconfirmed). Empty when HTML5 is on or no cause was given.

      Possible valuesstartingshell_not_readynet_jailmute_unconfirmed

    • orgHaltstringOptional

      Why the organisation’s screens are halted and black: read_only (the account is read-only; they start again when it is active) or disabled (disabled, or scheduled for deletion). Empty when they are not.

      Possible valuesread_onlydisabled

    • hardwareobjectOptional

      What the screen says it is (its own claim, never proof). tpm is true when it reported a TPM endorsement key; the key itself is never shown.

      Show child attributesHide child attributes
      • manufacturerstringOptional
      • modelstringOptional
      • serialstringOptional
      • tpmbooleanOptional
      • serialSharedbooleanOptional

        True when many PCs report this serial (a placeholder this organisation’s own screens show, or one staff confirmed). It identifies none of them, so the screen gets no “looks like” by serial. Omitted when false.

    • enrolledViaobjectOptionalNullable

      The install key the screen joined with; null for a screen added with a code. name is shown only to a caller with the Screens write permission, and never to staff acting as the organisation.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
    • enrolledAtstring (date-time)Optional

      When the screen joined (paired or enrolled). It never changes; the unassigned pool is listed in this order.

    • opencrsRefstringOptionalNullable

      The OpenCRS screen this screen is the face of, or null.

    • looksLikeCountintegerOptional

      How many of the organisation’s other screens (inside the caller’s scope) may be this same machine: the same serial and maker, or the same TPM key. Only an unassigned screen and a set-up one are ever paired: two unassigned screens never count each other. Lists carry the count; one screen’s own view also carries looksLike.

    • looksLikearray of objectsOptional

      Only in one screen’s own view (GET /devices/{id} and the answers to a change): the first 20 screens it may be the same machine as, in id order. looksLikeCount is the total; when there are more, looksLikeNext is the cursor to pass to GET /devices/{id}/looks-like as after.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • whystringOptional

        What the match rests on. Both are what the PC itself reported (its serial and maker, or its TPM key hash): a claim, not proof. Check the install key and the time it joined before you replace a screen with it.

        Possible valuesserialtpm

    • looksLikeNextstringOptional

      Only in one screen’s own view, and only when looksLike is not the whole list: the after for GET /devices/{id}/looks-like.

    • possibleCopybooleanOptional

      True when the machine’s identity changed since it enrolled in a way that looks like its files were copied to another machine. An owner clears it with cloneChecked: true.

    • copyProvenbooleanOptional

      True when Mestra has found that this screen’s identity is in use on another PC. A replace clears it, and so does the owner saying it is not a copy (cloneChecked).

    • keyCheckobjectOptionalNullable

      A PC set up from a provisioning package plays nothing until its check that Windows’ readable copy of the install key is gone has passed. state is checking, failed (the check could not finish; reason says why, and it tries again by itself) or exposed (it proved a readable copy of the key: revoke the key; reason names the places, with any piece of the key in a name masked). since is when the hold was first seen. Null when the screen is not held. checking and failed, and a failure’s reason, are the PC’s own report on its heartbeat: Mestra bounds and cleans the text but cannot check it, and a held PC is kept inert by its own agent (it is an unassigned pool row either way, which gets no content, commands or credentials). exposed is Mestra’s own mark, set only from a report the server verified against the key the screen joined with.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuescheckingfailedexposed

      • reasonstringOptional
      • sincestring (date-time)OptionalNullable
    • siteCodestringOptional

      The code of the site the screen is linked to; empty when it is not linked.

    • kindstringOptional

      single is a PC; group is a screen group: one screen made of several, with no PC of its own.

      Possible valuessinglegroup

    • groupobjectOptional

      On a member of a group (when the group is in your scope): which group and the member’s place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
    • membersarray of objectsOptional

      On a group: its screens, by place.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • namestringOptional
      • positionintegerOptional
      • onlinebooleanOptional
    • layoutobjectOptional

      On a group: its rows and columns, the gap and size you gave, the canvas that comes to, and the version to send with a change.

      Show child attributesHide child attributes
      • rowsintegerOptional
      • colsintegerOptional
      • bezelMmnumberOptionalNullable
      • diagInnumberOptionalNullable
      • canvasWintegerOptional
      • canvasHintegerOptional
      • gapPxintegerOptional
      • cellWintegerOptional
      • cellHintegerOptional
      • placedbooleanOptional
      • placingbooleanOptional
      • versionintegerOptional
      • identifyUntilstring (date-time)OptionalNullable
    • lookbooleanOptional

      The screen needs a look: it last showed something other than what it was told to, or it has several displays and Mestra uses one.

    • syncStatestringOptional

      On a placed group, in a paged list only: whether its screens are in step.

      Possible valuesplacingin_stepout_of_stepunknown

    • syncLatearray of integersOptional

      On a group that is out of step, in a paged list only: the positions of the members the reasons name, in order.

    • displayobjectOptionalNullable

      What the PC said about its displays: how many, the primary and whole desktop size, notSpanned (more than one display and Mestra shows on one), spanned (the graphics driver joins them into one) and sizeChanged (the size before its last change); null from a group and a PC that has not said.

      Show child attributesHide child attributes
      • monitorsintegerOptional
      • primaryWintegerOptional
      • primaryHintegerOptional
      • virtualWintegerOptional
      • virtualHintegerOptional
      • notSpannedbooleanOptional
      • spannedbooleanOptional
      • sizeChangedobjectOptionalNullable
        Show child attributesHide child attributes
        • fromWintegerOptional
        • fromHintegerOptional
        • toWintegerOptional
        • toHintegerOptional
    • soundstringOptionalNullable

      This screen’s own sound setting; null follows its site.

      Possible valuesonoffnull

    • panelVolumeintegerOptionalNullable

      This screen’s own panel volume; null follows its site.

    • hoursarray of valuesOptionalNullable

      This screen’s own on and off times; null follows its site.

    • brightnessarray of valuesOptionalNullable

      This screen’s own brightness times; null follows its site.

    • locationobjectOptionalNullable

      This screen’s own place; null follows its site.

      Show child attributesHide child attributes
      • latnumberOptional
      • lonnumberOptional
      • namestringOptional
      • addressstringOptional
      • citystringOptional
      • statestringOptional
      • postcodestringOptional
    • siteobjectOptionalNullable

      The site the screen is linked to; null when it has none.

      Show child attributesHide child attributes
      • keystringOptional

        The brand code.

      • namestringOptional
    • nowobjectOptional

      What the screen is showing, from its last report. While the screen or the organisation is stopped, state is stopped and entry is null, whatever the screen last said. off means its panel is switched off. entry is null when the screen isn’t showing an item or the item has been deleted.

      Show child attributesHide child attributes
      • statestringOptional

        Possible valuesplayingwaitingpairingstoppedoffunknown

      • entryobjectOptionalNullable
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

      • sincestring (date-time)OptionalNullable
    • nextobjectOptionalNullable

      The item the screen shows after this one. Null when the screen is stopped or has not said.

      Show child attributesHide child attributes
      • entryobjectOptional
        Show child attributesHide child attributes
        • idstring (uuid)Optional
        • namestringOptional
        • sha256stringOptional

          The entry’s file. A screen that is offline or has not caught up may still be showing an earlier one.

        • publicationIdstring (uuid)OptionalNullable

          The publication the item came from; null when the entry has no published item.

    • lastShotobjectOptional

      On a page of the screens list, for a screen with nothing booked now or next: its newest screenshot that has a small preview. Left out otherwise. thumb is the preview’s address, which holds the shot’s id and never changes.

      Show child attributesHide child attributes
      • idstring (uuid)Optional
      • thumbstringOptional
      • takenAtstring (date-time)Optional
    • healthobjectOptional

      online is the live check (the screen called within the last 3 minutes). presence is the state the webhooks follow, moved by the screen’s report and a once-a-minute sweep, so the two can differ for up to a minute.

      Show child attributesHide child attributes
      • onlinebooleanOptional
      • presencestringOptional

        Possible valuesonlineoffline

      • presenceSincestring (date-time)OptionalNullable
      • lastSeenAtstring (date-time)OptionalNullable
      • appVersionstringOptional
      • cacheBytesinteger (int64)OptionalNullable

        The size of the screen’s file cache; null until it reports.

      • issueobjectOptional

        The screen’s health line: what is wrong, or that it fixed itself, and what to do about it.

        Show child attributesHide child attributes
        • pillstringOptional

          Possible valuesHealthyFixed itselfNeeds a lookNeeds a visitOffline

        • titlestringOptional
        • fixstringOptional
        • sincestring (date-time)OptionalNullable

          When the fault began, or when it fixed itself.

        • codestringOptional
      • uptimeobjectOptional

        The screen’s last 30 days (its own days, to today) from the days Mestra has signed. Null fractions where no day was counted.

        Show child attributesHide child attributes
        • last30dnumberOptionalNullable
        • last30dExSitePowernumberOptionalNullable

          With the seconds lost to the site’s power left out of both sides.

        • trendobjectOptional

          Uptime a day at a time: 30 days, oldest first, each the up seconds over the counted seconds of that day, cut (never rounded up) to four places; null where nothing was counted. On a screen in a paged list, on a site in the list of sites, and on an uptime answer for the default span.

          Show child attributesHide child attributes
          • tostring (date)Optional

            The last of the 30 days.

          • daysarray of numbersOptional
        • todayobjectOptional

          On a page of the screens list: today so far in the screen’s zone, from the hours it has sealed since midnight. Always partial. It is not in trend, last30d or any signed day. Left out until an hour has been sealed today.

          Show child attributesHide child attributes
          • upnumberOptionalNullable

            Up seconds over counted seconds of those hours, cut (never rounded up) to four places.

          • hoursintegerOptional

            The sealed hours it rests on.

          • partialbooleanOptional
      • lastMismatchobjectOptionalNullable

        The last time the screen found a file that failed its check; entries are the entry ids (or stopshow for the stopped picture). Null when it never has.

        Show child attributesHide child attributes
        • atstring (date-time)Optional
        • entriesarray of stringsOptional
      • diagobjectOptionalNullable

        What the screen’s PC last reported about itself. Null for a group and for a screen that has not reported. Text the device wrote is not shown.

        Show child attributesHide child attributes
        • reportedAtstring (date-time)Optional
        • diskFreeBytesinteger (int64)OptionalNullable
        • diskTotalBytesinteger (int64)OptionalNullable
        • memTotalBytesinteger (int64)OptionalNullable
        • memAvailBytesinteger (int64)OptionalNullable
        • playerRamBytesinteger (int64)OptionalNullable

          The memory the player uses.

        • tempCnumberOptionalNullable

          The PC’s temperature in degrees Celsius.

        • clockOffsetMsintegerOptionalNullable

          How far the PC’s clock is from the server’s, in milliseconds.

        • bootedAtstring (date-time)OptionalNullable
        • shellUpbooleanOptional

          Whether the player’s shell is running.

Errors

StatusCodeMeaning
400

A bad power, or an until that is not a future time (with field).

401invalid_token

The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.

403wrong_keyscreens_limited

wrong_key, screens_limited, or a role below an owner’s.

404unknown_sitenot_connected

unknown_site, or not_connected.

409api_offintegration_off

api_off (an owner hasn’t turned the API on), or integration_off.

413

“body exceeds limit (<n> bytes)”.

429rate_limited

rate_limited: the power was changed too often in the last hour (Retry-After says when to try again).

501

The player is not available on this server.

Update the site of screens

PermissionScreens · Write

Needs the Screens write permission and an editor. Links screens to a site, or with an empty site takes them off their site.

Body parameters

  • framesarray of stringsRequired
  • sitestringRequired

Returns

How many screens were linked.

An object with:

  • linkedintegerOptional

Errors

StatusCodeMeaning
400

No screens, or an id that isn’t a screen.

401invalid_token

The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.

403wrong_keyplan_refused

wrong_key (the key or role can’t do this), a key limited to some screens, or plan_refused.

404not_connected

There’s no such site, or not_connected.

409api_offintegration_off

api_off, integration_off, or a screen that has a booking on it.