# Brix Screens API

**Canonical:** https://apis.io/apis/brixsignage-com/brixsignage-com-screens-api/  
**Provider:** Brix — https://apis.io/providers/brixsignage-com/  
**Base URL:** https://api.brixsignage.com  
**Documentation:** https://brixsignage.com/developers/api/

Brix Screens API is one of 69 APIs that [Brix](https://apis.io/providers/brixsignage-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Screens. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The screens API from Brix — 48 operation(s) for screens.

## Operations (51)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/screens` | List screens |
| POST | `/v1/screens` | Create a screen |
| DELETE | `/v1/screens/{id}` | Delete a screen |
| GET | `/v1/screens/{id}` | Get a screen |
| PATCH | `/v1/screens/{id}` | Update a screen's settings |
| POST | `/v1/screens/{id}/assign` | Set what a screen plays |
| POST | `/v1/screens/{id}/claim-replacement` | Replace a screen's device |
| POST | `/v1/screens/{id}/commands` | Send a command to a screen |
| GET | `/v1/screens/{id}/commands/{commandId}` | Get a command's status |
| GET | `/v1/screens/{id}/diagnose` | Diagnose a screen issue |
| GET | `/v1/screens/{id}/diagnostic-bundles` | List a screen's diagnostic bundles |
| GET | `/v1/screens/{id}/diagnostic-bundles/{bundleId}` | Download a diagnostic bundle |
| GET | `/v1/screens/{id}/diagnostics` | Get consolidated screen diagnostics |
| GET | `/v1/screens/{id}/display-history` | Get a screen's display history |
| GET | `/v1/screens/{id}/frames` | Get a screen's frame history |
| POST | `/v1/screens/{id}/kiosk-recovery/reveal` | Reveal a screen's recovery code |
| POST | `/v1/screens/{id}/kiosk-recovery/rotate` | Rotate a screen's recovery code |
| POST | `/v1/screens/{id}/lan-secret/rotate` | Rotate a screen's local network key |
| GET | `/v1/screens/{id}/live-thumbnail` | Get a screen's live thumbnail |
| GET | `/v1/screens/{id}/logs` | Get a screen's activity log |
| POST | `/v1/screens/{id}/mirror` | Start a screen mirror session |
| GET | `/v1/screens/{id}/outages` | Get a screen's outage history |
| GET | `/v1/screens/{id}/playback-quality` | Get a screen's playback quality |
| GET | `/v1/screens/{id}/preview` | Preview what a screen would play |
| GET | `/v1/screens/{id}/quality` | Get a screen's playback and device quality |
| POST | `/v1/screens/{id}/replace-device` | Unpair a screen's device |
| GET | `/v1/screens/{id}/resource-pressure` | Get a screen's resource pressure |
| POST | `/v1/screens/{id}/restore` | Restore a deleted screen |
| POST | `/v1/screens/{id}/revoke-device` | Revoke a screen's device access |
| POST | `/v1/screens/{id}/rotate-token` | Rotate a screen's device token |
| GET | `/v1/screens/{id}/state` | Get a screen's reported device state |
| GET | `/v1/screens/{id}/telemetry` | Get a screen's raw telemetry |
| POST | `/v1/screens/{id}/trigger` | Trigger a screen interaction |
| POST | `/v1/screens/{id}/unpower-and-delete` | Power off and delete a screen |
| GET | `/v1/screens/{id}/up-next` | Get a screen's up-next schedule |
| GET | `/v1/screens/{id}/why` | Explain what a screen shows and why |
| POST | `/v1/screens/bulk-assign` | Set what many screens play |
| POST | `/v1/screens/bulk-settings` | Apply settings to many screens |
| POST | `/v1/screens/claim` | Pair a device by its code |
| POST | `/v1/screens/commands` | Send a command to many screens |
| GET | `/v1/screens/count-by-status` | Count screens by status |
| POST | `/v1/screens/enroll` | Enroll a screen programmatically |
| POST | `/v1/screens/heavy-check` | Check if content is too heavy for screens |
| GET | `/v1/screens/pair-cost` | Price one more screen |
| GET | `/v1/screens/pending` | List pending discovered devices |
| POST | `/v1/screens/pending/{id}/dismiss` | Dismiss a pending device |
| POST | `/v1/screens/pending/{id}/identify` | Identify a pending device |
| POST | `/v1/screens/pending/claim` | Claim multiple discovered devices |
| POST | `/v1/screens/pending/identify-all` | Identify all pending devices |
| GET | `/v1/screens/recycle-bin` | List deleted screens |
| GET | `/v1/screens/touch-content` | Which of the named content refs (creative:/layout:/playlist:) carry tap… |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/brixsignage-com/openapi/brixsignage-com-screens-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-screen-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-manifest-preview-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-updated-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-workspace-prefs-schema.json

## Other Brix APIs (12)

- [Brix Account API](https://apis.io/apis/brixsignage-com/brixsignage-com-account-api/)
- [Brix Ad Slots API](https://apis.io/apis/brixsignage-com/brixsignage-com-ad-slots-api/)
- [Brix AI API](https://apis.io/apis/brixsignage-com/brixsignage-com-ai-api/)
- [Brix Alert Channels API](https://apis.io/apis/brixsignage-com/brixsignage-com-alert-channels-api/)
- [Brix Alert Events API](https://apis.io/apis/brixsignage-com/brixsignage-com-alert-events-api/)
- [Brix Alert Rules API](https://apis.io/apis/brixsignage-com/brixsignage-com-alert-rules-api/)
- [Brix Alerts API](https://apis.io/apis/brixsignage-com/brixsignage-com-alerts-api/)
- [Brix API Keys API](https://apis.io/apis/brixsignage-com/brixsignage-com-api-keys-api/)
- [Brix App Instances API](https://apis.io/apis/brixsignage-com/brixsignage-com-app-instances-api/)
- [Brix Approvals API](https://apis.io/apis/brixsignage-com/brixsignage-com-approvals-api/)
- [Brix Apps API](https://apis.io/apis/brixsignage-com/brixsignage-com-apps-api/)
- [Brix Audit API](https://apis.io/apis/brixsignage-com/brixsignage-com-audit-api/)

## Tags

Screens

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/brixsignage-com/brixsignage-com-screens-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/brixsignage-com/.