app-instances

Get an app instance thumbnail

Retrieve a shared preview image of an app instance. The same image is reused everywhere the app is previewed, so it loads quickly. Add ?fresh=1 to force a new image to be generated after a configuration change.

Notes.

  • A cached image is image/jpeg. When there is none yet, the answer is a neutral image/svg+xml placeholder (header x-brix-cache: pending, not cached) while the image is drawn in the background; fetch it again shortly.
get/v1/app-instances/{id}/thumbnail

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/app-instances/{id}/thumbnail
  • Auth: HTTP bearer

Path parameters

idstring required

App instance id.

Query parameters

fresh'1'

Skip the cached image and draw it again.

Response

Success. The body is the file itself.

Changes

No recorded changes to this operation across all 2 revisions of this API.