> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/openapi/display.md).

# Display

Displays

## Display Search

> Search Displays for this User

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Display":{"properties":{"displayId":{"description":"The ID of this Display","type":"integer"},"displayTypeId":{"description":"The Display Type ID of this Display","type":"integer"},"venueId":{"description":"The Venue ID of this Display","type":"integer"},"address":{"description":"The Location Address of this Display","type":"string"},"isMobile":{"description":"Is this Display mobile?","type":"integer"},"languages":{"description":"The Languages supported in this display location","type":"string"},"displayType":{"description":"The type of this Display","type":"string"},"screenSize":{"description":"The screen size of this Display","type":"integer"},"isOutdoor":{"description":"Is this Display Outdoor?","type":"integer"},"customId":{"description":"The custom ID (an Id of any external system) of this Display","type":"string"},"costPerPlay":{"description":"The Cost Per Play of this Display","type":"number","format":"double"},"impressionsPerPlay":{"description":"The Impressions Per Play of this Display","type":"number","format":"double"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"},"auditingUntil":{"description":"Flag indicating whether this Display is recording Auditing Information from XMDS","type":"integer"},"display":{"description":"The Name of this Display","type":"string"},"description":{"description":"The Description of this Display","type":"string"},"defaultLayoutId":{"description":"The ID of the Default Layout","type":"integer"},"license":{"description":"The Display Unique Identifier also called hardware key","type":"string"},"licensed":{"description":"A flag indicating whether this Display is licensed or not","type":"integer"},"loggedIn":{"description":"A flag indicating whether this Display is currently logged in","type":"integer"},"lastAccessed":{"description":"A timestamp in CMS time for the last time the Display accessed XMDS","type":"integer"},"incSchedule":{"description":"A flag indicating whether the default layout is interleaved with the Schedule","type":"integer"},"emailAlert":{"description":"A flag indicating whether the Display will send email alerts.","type":"integer"},"alertTimeout":{"description":"A timeout in seconds for the Display to send email alerts.","type":"integer"},"clientAddress":{"description":"The MAC Address of the Display","type":"string"},"mediaInventoryStatus":{"description":"The media inventory status of the Display","type":"integer"},"macAddress":{"description":"The current Mac Address of the Player","type":"string"},"lastChanged":{"description":"A timestamp indicating the last time the Mac Address changed","type":"integer"},"numberOfMacAddressChanges":{"description":"A count of Mac Address changes","type":"integer"},"lastWakeOnLanCommandSent":{"description":"A timestamp indicating the last time a WOL command was sent","type":"integer"},"wakeOnLanEnabled":{"description":"A flag indicating whether Wake On Lan is enabled","type":"integer"},"wakeOnLanTime":{"description":"A h:i string indicating the time to send a WOL command","type":"string"},"broadCastAddress":{"description":"The broad cast address for this Display","type":"string"},"secureOn":{"description":"The secureOn WOL settings for this display.","type":"string"},"cidr":{"description":"The CIDR WOL settings for this display","type":"string"},"latitude":{"description":"The display Latitude","type":"number","format":"double"},"longitude":{"description":"The display longitude","type":"number","format":"double"},"clientType":{"description":"A string representing the player type","type":"string"},"clientVersion":{"description":"A string representing the player version","type":"string"},"clientCode":{"description":"A number representing the Player version code","type":"integer"},"displayProfileId":{"description":"The display settings profile ID for this Display","type":"integer"},"currentLayoutId":{"description":"The current layout ID reported via XMDS","type":"integer"},"screenShotRequested":{"description":"A flag indicating that a screen shot should be taken by the Player","type":"integer"},"storageAvailableSpace":{"description":"The number of bytes of storage available on the device.","type":"integer"},"storageTotalSpace":{"description":"The number of bytes of storage in total on the device","type":"integer"},"displayGroupId":{"description":"The ID of the Display Group for this Device","type":"integer"},"currentLayout":{"description":"The current layout","type":"string"},"defaultLayout":{"description":"The default layout","type":"string"},"displayGroups":{"description":"The Display Groups this Display belongs to","type":"array","items":{"$ref":"#/components/schemas/DisplayGroup"}},"xmrChannel":{"description":"The Player Subscription Channel","type":"string"},"xmrPubKey":{"description":"The Player Public Key","type":"string"},"lastCommandSuccess":{"description":"The last command success, 0 = failure, 1 = success, 2 = unknown","type":"integer"},"deviceName":{"description":"The Device Name for the device hardware associated with this Display","type":"string"},"timeZone":{"description":"The Display Timezone, or empty to use the CMS timezone","type":"string"},"tags":{"description":"Tags associated with this Display, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"overrideConfig":{"description":"The configuration options that will overwrite Display Profile Config"},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"newCmsAddress":{"description":"The new CMS Address","type":"string"},"newCmsKey":{"description":"The new CMS Key","type":"string"},"orientation":{"description":"The orientation of the Display, either landscape or portrait","type":"string"},"resolution":{"description":"The resolution of the Display expressed as a string in the format WxH","type":"string"},"commercialLicence":{"description":"Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable","type":"integer"},"teamViewerSerial":{"description":"The TeamViewer serial number for this Display","type":"string"},"webkeySerial":{"description":"The Webkey serial number for this Display","type":"string"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this Display","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display","type":"integer"},"countFaults":{"description":"The count of Player reported faults","type":"integer"},"lanIpAddress":{"description":"LAN IP Address, if available on the Player","type":"string"},"syncGroupId":{"description":"The Display Group ID this Display is synced to","type":"integer"},"osVersion":{"description":"The OS version of the Display","type":"string"},"osSdk":{"description":"The SDK version of the Display","type":"string"},"manufacturer":{"description":"The manufacturer of the Display","type":"string"},"brand":{"description":"The brand of the Display","type":"string"},"model":{"description":"The model of the Display","type":"string"}}},"DisplayGroup":{"properties":{"displayGroupId":{"description":"The displayGroup Id","type":"integer"},"displayGroup":{"description":"The displayGroup Name","type":"string"},"description":{"description":"The displayGroup Description","type":"string"},"isDisplaySpecific":{"description":"A flag indicating whether this displayGroup is a single display displayGroup","type":"integer"},"isDynamic":{"description":"A flag indicating whether this displayGroup is dynamic","type":"integer"},"dynamicCriteria":{"description":"Criteria for this dynamic group. A comma separated set of regular expressions to apply","type":"string"},"dynamicCriteriaLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND","type":"string"},"dynamicCriteriaTags":{"description":"Criteria for this dynamic group. A comma separated set of tags to apply","type":"string"},"dynamicCriteriaExactTags":{"description":"Flag indicating whether to filter by exact Tag match","type":"integer"},"dynamicCriteriaTagsLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple Tags? OR|AND","type":"string"},"userId":{"description":"The UserId who owns this display group","type":"integer"},"tags":{"description":"Tags associated with this Display Group, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this DisplayGroup","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display Group","type":"integer"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"}}},"TagLink":{"properties":{"tag":{"description":"The Tag","type":"string"},"tagId":{"description":"The Tag ID","type":"integer"},"value":{"description":"The Tag Value","type":"string"}}}}},"paths":{"/display":{"get":{"tags":["display"],"summary":"Display Search","description":"Search Displays for this User","operationId":"displaySearch","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"query","description":"Filter by Display Id","required":false},{"schema":{"type":"integer"},"name":"displayGroupId","in":"query","description":"Filter by DisplayGroup Id","required":false},{"schema":{"type":"string"},"name":"display","in":"query","description":"Filter by Display Name","required":false},{"schema":{"type":"string"},"name":"tags","in":"query","description":"Filter by tags","required":false},{"schema":{"type":"integer"},"name":"exactTags","in":"query","description":"A flag indicating whether to treat the tags filter as an exact match","required":false},{"schema":{"type":"string"},"name":"logicalOperator","in":"query","description":"When filtering by multiple Tags, which logical operator should be used? AND|OR","required":false},{"schema":{"type":"string"},"name":"macAddress","in":"query","description":"Filter by Mac Address","required":false},{"schema":{"type":"string"},"name":"hardwareKey","in":"query","description":"Filter by Hardware Key","required":false},{"schema":{"type":"string"},"name":"clientVersion","in":"query","description":"Filter by Client Version","required":false},{"schema":{"type":"string"},"name":"clientType","in":"query","description":"Filter by Client Type","required":false},{"schema":{"type":"string"},"name":"clientCode","in":"query","description":"Filter by Client Code","required":false},{"schema":{"type":"string"},"name":"embed","in":"query","description":"Embed related data, namely displaygroups. A comma separated list of child objects to embed.","required":false},{"schema":{"type":"integer"},"name":"authorised","in":"query","description":"Filter by authorised flag","required":false},{"schema":{"type":"integer"},"name":"displayProfileId","in":"query","description":"Filter by Display Profile","required":false},{"schema":{"type":"integer"},"name":"mediaInventoryStatus","in":"query","description":"Filter by Display Status ( 1 - up to date, 2 - downloading, 3 - Out of date)","required":false},{"schema":{"type":"integer"},"name":"loggedIn","in":"query","description":"Filter by Logged In flag","required":false},{"schema":{"type":"string"},"name":"lastAccessed","in":"query","description":"Filter by Display Last Accessed date, expects date in Y-m-d H:i:s format","required":false},{"schema":{"type":"integer"},"name":"folderId","in":"query","description":"Filter by Folder ID","required":false},{"schema":{"type":"integer"},"name":"xmrRegistered","in":"query","description":"Filter by whether XMR is registed (1 or 0)","required":false},{"schema":{"type":"integer"},"name":"isPlayerSupported","in":"query","description":"Filter by whether the player is supported (1 or 0)","required":false}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Display"}}}}}}}}}}
```

## Display Edit

> Edit a Display

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Display":{"properties":{"displayId":{"description":"The ID of this Display","type":"integer"},"displayTypeId":{"description":"The Display Type ID of this Display","type":"integer"},"venueId":{"description":"The Venue ID of this Display","type":"integer"},"address":{"description":"The Location Address of this Display","type":"string"},"isMobile":{"description":"Is this Display mobile?","type":"integer"},"languages":{"description":"The Languages supported in this display location","type":"string"},"displayType":{"description":"The type of this Display","type":"string"},"screenSize":{"description":"The screen size of this Display","type":"integer"},"isOutdoor":{"description":"Is this Display Outdoor?","type":"integer"},"customId":{"description":"The custom ID (an Id of any external system) of this Display","type":"string"},"costPerPlay":{"description":"The Cost Per Play of this Display","type":"number","format":"double"},"impressionsPerPlay":{"description":"The Impressions Per Play of this Display","type":"number","format":"double"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"},"auditingUntil":{"description":"Flag indicating whether this Display is recording Auditing Information from XMDS","type":"integer"},"display":{"description":"The Name of this Display","type":"string"},"description":{"description":"The Description of this Display","type":"string"},"defaultLayoutId":{"description":"The ID of the Default Layout","type":"integer"},"license":{"description":"The Display Unique Identifier also called hardware key","type":"string"},"licensed":{"description":"A flag indicating whether this Display is licensed or not","type":"integer"},"loggedIn":{"description":"A flag indicating whether this Display is currently logged in","type":"integer"},"lastAccessed":{"description":"A timestamp in CMS time for the last time the Display accessed XMDS","type":"integer"},"incSchedule":{"description":"A flag indicating whether the default layout is interleaved with the Schedule","type":"integer"},"emailAlert":{"description":"A flag indicating whether the Display will send email alerts.","type":"integer"},"alertTimeout":{"description":"A timeout in seconds for the Display to send email alerts.","type":"integer"},"clientAddress":{"description":"The MAC Address of the Display","type":"string"},"mediaInventoryStatus":{"description":"The media inventory status of the Display","type":"integer"},"macAddress":{"description":"The current Mac Address of the Player","type":"string"},"lastChanged":{"description":"A timestamp indicating the last time the Mac Address changed","type":"integer"},"numberOfMacAddressChanges":{"description":"A count of Mac Address changes","type":"integer"},"lastWakeOnLanCommandSent":{"description":"A timestamp indicating the last time a WOL command was sent","type":"integer"},"wakeOnLanEnabled":{"description":"A flag indicating whether Wake On Lan is enabled","type":"integer"},"wakeOnLanTime":{"description":"A h:i string indicating the time to send a WOL command","type":"string"},"broadCastAddress":{"description":"The broad cast address for this Display","type":"string"},"secureOn":{"description":"The secureOn WOL settings for this display.","type":"string"},"cidr":{"description":"The CIDR WOL settings for this display","type":"string"},"latitude":{"description":"The display Latitude","type":"number","format":"double"},"longitude":{"description":"The display longitude","type":"number","format":"double"},"clientType":{"description":"A string representing the player type","type":"string"},"clientVersion":{"description":"A string representing the player version","type":"string"},"clientCode":{"description":"A number representing the Player version code","type":"integer"},"displayProfileId":{"description":"The display settings profile ID for this Display","type":"integer"},"currentLayoutId":{"description":"The current layout ID reported via XMDS","type":"integer"},"screenShotRequested":{"description":"A flag indicating that a screen shot should be taken by the Player","type":"integer"},"storageAvailableSpace":{"description":"The number of bytes of storage available on the device.","type":"integer"},"storageTotalSpace":{"description":"The number of bytes of storage in total on the device","type":"integer"},"displayGroupId":{"description":"The ID of the Display Group for this Device","type":"integer"},"currentLayout":{"description":"The current layout","type":"string"},"defaultLayout":{"description":"The default layout","type":"string"},"displayGroups":{"description":"The Display Groups this Display belongs to","type":"array","items":{"$ref":"#/components/schemas/DisplayGroup"}},"xmrChannel":{"description":"The Player Subscription Channel","type":"string"},"xmrPubKey":{"description":"The Player Public Key","type":"string"},"lastCommandSuccess":{"description":"The last command success, 0 = failure, 1 = success, 2 = unknown","type":"integer"},"deviceName":{"description":"The Device Name for the device hardware associated with this Display","type":"string"},"timeZone":{"description":"The Display Timezone, or empty to use the CMS timezone","type":"string"},"tags":{"description":"Tags associated with this Display, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"overrideConfig":{"description":"The configuration options that will overwrite Display Profile Config"},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"newCmsAddress":{"description":"The new CMS Address","type":"string"},"newCmsKey":{"description":"The new CMS Key","type":"string"},"orientation":{"description":"The orientation of the Display, either landscape or portrait","type":"string"},"resolution":{"description":"The resolution of the Display expressed as a string in the format WxH","type":"string"},"commercialLicence":{"description":"Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable","type":"integer"},"teamViewerSerial":{"description":"The TeamViewer serial number for this Display","type":"string"},"webkeySerial":{"description":"The Webkey serial number for this Display","type":"string"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this Display","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display","type":"integer"},"countFaults":{"description":"The count of Player reported faults","type":"integer"},"lanIpAddress":{"description":"LAN IP Address, if available on the Player","type":"string"},"syncGroupId":{"description":"The Display Group ID this Display is synced to","type":"integer"},"osVersion":{"description":"The OS version of the Display","type":"string"},"osSdk":{"description":"The SDK version of the Display","type":"string"},"manufacturer":{"description":"The manufacturer of the Display","type":"string"},"brand":{"description":"The brand of the Display","type":"string"},"model":{"description":"The model of the Display","type":"string"}}},"DisplayGroup":{"properties":{"displayGroupId":{"description":"The displayGroup Id","type":"integer"},"displayGroup":{"description":"The displayGroup Name","type":"string"},"description":{"description":"The displayGroup Description","type":"string"},"isDisplaySpecific":{"description":"A flag indicating whether this displayGroup is a single display displayGroup","type":"integer"},"isDynamic":{"description":"A flag indicating whether this displayGroup is dynamic","type":"integer"},"dynamicCriteria":{"description":"Criteria for this dynamic group. A comma separated set of regular expressions to apply","type":"string"},"dynamicCriteriaLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND","type":"string"},"dynamicCriteriaTags":{"description":"Criteria for this dynamic group. A comma separated set of tags to apply","type":"string"},"dynamicCriteriaExactTags":{"description":"Flag indicating whether to filter by exact Tag match","type":"integer"},"dynamicCriteriaTagsLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple Tags? OR|AND","type":"string"},"userId":{"description":"The UserId who owns this display group","type":"integer"},"tags":{"description":"Tags associated with this Display Group, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this DisplayGroup","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display Group","type":"integer"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"}}},"TagLink":{"properties":{"tag":{"description":"The Tag","type":"string"},"tagId":{"description":"The Tag ID","type":"integer"},"value":{"description":"The Tag Value","type":"string"}}}}},"paths":{"/display/{displayId}":{"put":{"tags":["display"],"summary":"Display Edit","description":"Edit a Display","operationId":"displayEdit","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Display"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"display":{"type":"string","description":"The Display Name"},"description":{"type":"string","description":"A description of the Display"},"tags":{"type":"string","description":"A comma separated list of tags for this item"},"auditingUntil":{"type":"string","description":"A date this Display records auditing information until.","format":"date-time"},"defaultLayoutId":{"type":"integer","description":"A Layout ID representing the Default Layout for this Display."},"licensed":{"type":"integer","description":"Flag indicating whether this display is licensed."},"license":{"type":"string","description":"The hardwareKey to use as the licence key for this Display"},"incSchedule":{"type":"integer","description":"Flag indicating whether the Default Layout should be included in the Schedule"},"emailAlert":{"type":"integer","description":"Flag indicating whether the Display generates up/down email alerts."},"alertTimeout":{"type":"integer","description":"How long in seconds should this display wait before alerting when it hasn't connected. Override for the collection interval."},"wakeOnLanEnabled":{"type":"integer","description":"Flag indicating if Wake On LAN is enabled for this Display"},"wakeOnLanTime":{"type":"string","description":"A h:i string representing the time that the Display should receive its Wake on LAN command"},"broadCastAddress":{"type":"string","description":"The BroadCast Address for this Display - used by Wake On LAN"},"secureOn":{"type":"string","description":"The secure on configuration for this Display"},"cidr":{"type":"integer","description":"The CIDR configuration for this Display"},"latitude":{"type":"number","description":"The Latitude of this Display"},"longitude":{"type":"number","description":"The Longitude of this Display"},"timeZone":{"type":"string","description":"The timezone for this display, or empty to use the CMS timezone"},"languages":{"type":"string","description":"An array of languages supported in this display location"},"displayProfileId":{"type":"integer","description":"The Display Settings Profile ID"},"displayTypeId":{"type":"integer","description":"The Display Type ID of this Display"},"screenSize":{"type":"number","description":"The screen size of this Display"},"venueId":{"type":"integer","description":"The Venue ID of this Display"},"address":{"type":"string","description":"The Location Address of this Display"},"isMobile":{"type":"integer","description":"Is this Display mobile?"},"isOutdoor":{"type":"integer","description":"Is this Display Outdoor?"},"costPerPlay":{"type":"number","description":"The Cost Per Play of this Display"},"impressionsPerPlay":{"type":"integer","description":"The Impressions Per Play of this Display"},"customId":{"type":"string","description":"The custom ID (an Id of any external system) of this Display"},"ref1":{"type":"string","description":"Reference 1"},"ref2":{"type":"string","description":"Reference 2"},"ref3":{"type":"string","description":"Reference 3"},"ref4":{"type":"string","description":"Reference 4"},"ref5":{"type":"string","description":"Reference 5"},"clearCachedData":{"type":"integer","description":"Clear all Cached data for this display"},"rekeyXmr":{"type":"integer","description":"Clear the cached XMR configuration and send a rekey"},"teamViewerSerial":{"type":"string","description":"The TeamViewer serial number for this Display, if applicable"},"webkeySerial":{"type":"string","description":"The Webkey serial number for this Display, if applicable"},"folderId":{"type":"integer","description":"Folder ID to which this object should be assigned to"}},"required":["display","defaultLayoutId","licensed","license","incSchedule","emailAlert","wakeOnLanEnabled"]}}}}}}}}
```

## Display Delete

> Delete a Display

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/display/{displayId}":{"delete":{"tags":["display"],"summary":"Display Delete","description":"Delete a Display","operationId":"displayDelete","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Request Screen Shot

> Notify the display that the CMS would like a screen shot to be sent.

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Display":{"properties":{"displayId":{"description":"The ID of this Display","type":"integer"},"displayTypeId":{"description":"The Display Type ID of this Display","type":"integer"},"venueId":{"description":"The Venue ID of this Display","type":"integer"},"address":{"description":"The Location Address of this Display","type":"string"},"isMobile":{"description":"Is this Display mobile?","type":"integer"},"languages":{"description":"The Languages supported in this display location","type":"string"},"displayType":{"description":"The type of this Display","type":"string"},"screenSize":{"description":"The screen size of this Display","type":"integer"},"isOutdoor":{"description":"Is this Display Outdoor?","type":"integer"},"customId":{"description":"The custom ID (an Id of any external system) of this Display","type":"string"},"costPerPlay":{"description":"The Cost Per Play of this Display","type":"number","format":"double"},"impressionsPerPlay":{"description":"The Impressions Per Play of this Display","type":"number","format":"double"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"},"auditingUntil":{"description":"Flag indicating whether this Display is recording Auditing Information from XMDS","type":"integer"},"display":{"description":"The Name of this Display","type":"string"},"description":{"description":"The Description of this Display","type":"string"},"defaultLayoutId":{"description":"The ID of the Default Layout","type":"integer"},"license":{"description":"The Display Unique Identifier also called hardware key","type":"string"},"licensed":{"description":"A flag indicating whether this Display is licensed or not","type":"integer"},"loggedIn":{"description":"A flag indicating whether this Display is currently logged in","type":"integer"},"lastAccessed":{"description":"A timestamp in CMS time for the last time the Display accessed XMDS","type":"integer"},"incSchedule":{"description":"A flag indicating whether the default layout is interleaved with the Schedule","type":"integer"},"emailAlert":{"description":"A flag indicating whether the Display will send email alerts.","type":"integer"},"alertTimeout":{"description":"A timeout in seconds for the Display to send email alerts.","type":"integer"},"clientAddress":{"description":"The MAC Address of the Display","type":"string"},"mediaInventoryStatus":{"description":"The media inventory status of the Display","type":"integer"},"macAddress":{"description":"The current Mac Address of the Player","type":"string"},"lastChanged":{"description":"A timestamp indicating the last time the Mac Address changed","type":"integer"},"numberOfMacAddressChanges":{"description":"A count of Mac Address changes","type":"integer"},"lastWakeOnLanCommandSent":{"description":"A timestamp indicating the last time a WOL command was sent","type":"integer"},"wakeOnLanEnabled":{"description":"A flag indicating whether Wake On Lan is enabled","type":"integer"},"wakeOnLanTime":{"description":"A h:i string indicating the time to send a WOL command","type":"string"},"broadCastAddress":{"description":"The broad cast address for this Display","type":"string"},"secureOn":{"description":"The secureOn WOL settings for this display.","type":"string"},"cidr":{"description":"The CIDR WOL settings for this display","type":"string"},"latitude":{"description":"The display Latitude","type":"number","format":"double"},"longitude":{"description":"The display longitude","type":"number","format":"double"},"clientType":{"description":"A string representing the player type","type":"string"},"clientVersion":{"description":"A string representing the player version","type":"string"},"clientCode":{"description":"A number representing the Player version code","type":"integer"},"displayProfileId":{"description":"The display settings profile ID for this Display","type":"integer"},"currentLayoutId":{"description":"The current layout ID reported via XMDS","type":"integer"},"screenShotRequested":{"description":"A flag indicating that a screen shot should be taken by the Player","type":"integer"},"storageAvailableSpace":{"description":"The number of bytes of storage available on the device.","type":"integer"},"storageTotalSpace":{"description":"The number of bytes of storage in total on the device","type":"integer"},"displayGroupId":{"description":"The ID of the Display Group for this Device","type":"integer"},"currentLayout":{"description":"The current layout","type":"string"},"defaultLayout":{"description":"The default layout","type":"string"},"displayGroups":{"description":"The Display Groups this Display belongs to","type":"array","items":{"$ref":"#/components/schemas/DisplayGroup"}},"xmrChannel":{"description":"The Player Subscription Channel","type":"string"},"xmrPubKey":{"description":"The Player Public Key","type":"string"},"lastCommandSuccess":{"description":"The last command success, 0 = failure, 1 = success, 2 = unknown","type":"integer"},"deviceName":{"description":"The Device Name for the device hardware associated with this Display","type":"string"},"timeZone":{"description":"The Display Timezone, or empty to use the CMS timezone","type":"string"},"tags":{"description":"Tags associated with this Display, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"overrideConfig":{"description":"The configuration options that will overwrite Display Profile Config"},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"newCmsAddress":{"description":"The new CMS Address","type":"string"},"newCmsKey":{"description":"The new CMS Key","type":"string"},"orientation":{"description":"The orientation of the Display, either landscape or portrait","type":"string"},"resolution":{"description":"The resolution of the Display expressed as a string in the format WxH","type":"string"},"commercialLicence":{"description":"Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable","type":"integer"},"teamViewerSerial":{"description":"The TeamViewer serial number for this Display","type":"string"},"webkeySerial":{"description":"The Webkey serial number for this Display","type":"string"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this Display","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display","type":"integer"},"countFaults":{"description":"The count of Player reported faults","type":"integer"},"lanIpAddress":{"description":"LAN IP Address, if available on the Player","type":"string"},"syncGroupId":{"description":"The Display Group ID this Display is synced to","type":"integer"},"osVersion":{"description":"The OS version of the Display","type":"string"},"osSdk":{"description":"The SDK version of the Display","type":"string"},"manufacturer":{"description":"The manufacturer of the Display","type":"string"},"brand":{"description":"The brand of the Display","type":"string"},"model":{"description":"The model of the Display","type":"string"}}},"DisplayGroup":{"properties":{"displayGroupId":{"description":"The displayGroup Id","type":"integer"},"displayGroup":{"description":"The displayGroup Name","type":"string"},"description":{"description":"The displayGroup Description","type":"string"},"isDisplaySpecific":{"description":"A flag indicating whether this displayGroup is a single display displayGroup","type":"integer"},"isDynamic":{"description":"A flag indicating whether this displayGroup is dynamic","type":"integer"},"dynamicCriteria":{"description":"Criteria for this dynamic group. A comma separated set of regular expressions to apply","type":"string"},"dynamicCriteriaLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND","type":"string"},"dynamicCriteriaTags":{"description":"Criteria for this dynamic group. A comma separated set of tags to apply","type":"string"},"dynamicCriteriaExactTags":{"description":"Flag indicating whether to filter by exact Tag match","type":"integer"},"dynamicCriteriaTagsLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple Tags? OR|AND","type":"string"},"userId":{"description":"The UserId who owns this display group","type":"integer"},"tags":{"description":"Tags associated with this Display Group, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this DisplayGroup","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display Group","type":"integer"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"}}},"TagLink":{"properties":{"tag":{"description":"The Tag","type":"string"},"tagId":{"description":"The Tag ID","type":"integer"},"value":{"description":"The Tag Value","type":"string"}}}}},"paths":{"/display/requestscreenshot/{displayId}":{"put":{"tags":["display"],"summary":"Request Screen Shot","description":"Notify the display that the CMS would like a screen shot to be sent.","operationId":"displayRequestScreenshot","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Display"}}}}}}}}}
```

## Issue WOL

> Send a Wake On LAN packet to this Display

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/display/wol/{displayId}":{"post":{"tags":["display"],"summary":"Issue WOL","description":"Send a Wake On LAN packet to this Display","operationId":"displayWakeOnLan","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Toggle authorised

> Toggle authorised for the Display.

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/display/authorise/{displayId}":{"put":{"tags":["display"],"summary":"Toggle authorised","description":"Toggle authorised for the Display.","operationId":"displayToggleAuthorise","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Set Default Layout

> Set the default Layout on this Display

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/display/defaultlayout/{displayId}":{"put":{"tags":["display"],"summary":"Set Default Layout","description":"Set the default Layout on this Display","operationId":"displayDefaultLayout","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"204":{"description":"successful operation"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"layoutId":{"type":"integer","description":"The Layout ID"}},"required":["layoutId"]}}}}}}}}
```

## Licence Check

> Ask this Player to check its Commercial Licence

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/display/licenceCheck/{displayId}":{"put":{"tags":["display"],"summary":"Licence Check","description":"Ask this Player to check its Commercial Licence","operationId":"displayLicenceCheck","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Display Status

> Get the display status window for this Display.

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/display/status/{id}":{"get":{"tags":["display"],"summary":"Display Status","description":"Get the display status window for this Display.","operationId":"displayStatus","parameters":[{"schema":{"type":"integer"},"name":"id","in":"path","description":"Display Id","required":true}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}}
```

## Purge All

> Ask this Player to purge all Media from its local storage and request fresh files from CMS.

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"display","description":"Displays"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/display/purgeAll/{displayId}":{"put":{"tags":["display"],"summary":"Purge All","description":"Ask this Player to purge all Media from its local storage and request fresh files from CMS.","operationId":"displayPurgeAll","parameters":[{"schema":{"type":"integer"},"name":"displayId","in":"path","description":"The Display ID","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/developer/integrate/openapi/display.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.