app-instances

Create an app instance

Configure an app for the workspace with an appKey, name, and optional config and nodeId. appKey must match one of the apps offered by the store; list the available keys first with GET /v1/apps/catalog.

Notes.

  • The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example lastSnapshotAt) are absent rather than null. GET returns every column.
post/v1/app-instances

Request

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

Request body

appKeystring required

A key from GET /v1/apps/catalog. An unknown key is refused (422 unknown_app).

namestring required
nodeIdstring nullable

Home location. Default: the caller's own location.

Response

Success.

Example response

{
  "data": {
    "id": "app_3c4d5e6f7a8b9c0d"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.