app-instances

Update an app instance

Edit a configured app's name, configuration, or node. config replaces the entire configuration, so read the current value first before submitting changes.

patch/v1/app-instances/{id}

Request

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

Path parameters

idstring required

App instance id.

Request body

appKeystring

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

namestring
nodeIdstring nullable

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

baseUpdatedAtstring

Optimistic concurrency: the updatedAt you read. A stale value is refused with 409 conflict and the current row.

Response

Success.

Example response

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

Changes

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