What the API can and cannot do
The API can register a Windows Edge, list its details, assign Screens and archive its record. Registration does not install, start or pair the software. Edge pairing still uses the Layarva dashboard and the Edge application. An Edge-served LAN display is different from a Screen importing an offline package. See offline API availability for package export.Before you start
Use the Postman setup:platform_base is https://api.layarva.com/api/platform/v1/workspaces/YOUR_WORKSPACE_ID, with a Platform / Workspace key, not a Widget key.
For POST and DELETE, use Body → raw → JSON, Content-Type: application/json and a new Idempotency-Key per new change. GET needs no body or operation key.
Select edges.read, edges.create, edges.archive, and the required Screen permissions. The key’s account must have the matching Queue view/manage permissions used for Edge management in Layarva. Edge and Screen plan capacity still applies.
Existing keys do not automatically gain new permissions. If necessary, create a replacement with the required scopes, update your integration, then revoke the old key.
Step 1: List or find an Edge
Send GET{{platform_base}}/edges?limit=25.
To find a paired Edge, use /edges?status=ACTIVE&limit=25. Search by name with q=Branch, or by exact ID with id=YOUR_EDGE_ID.
The response contains data and page. Save the selected Edge’s id as edge_id. For another page, use after={{next_cursor}} with the returned page.nextCursor; stop when null.
Step 2: Register a new Windows Edge if needed
Send POST{{platform_base}}/edges:
status: "PENDING". Save data.id as edge_id.
Names must be 2–120 characters and unique in your workspace, including retained archived names. platform is optional and defaults to WINDOWS; this management endpoint currently does not create an Android Edge.
Step 3: Pair the Edge application
- Install and open the current Windows Layarva Edge application on the branch computer.
- Open Screens → Edge in your Layarva workspace.
- Select the registered Edge and use its pairing-code action.
- Enter that temporary code in the Edge application’s pairing setup.
- Read GET
{{platform_base}}/edges/{{edge_id}}and confirmdata.statusisACTIVE.
The Platform management API does not issue Edge pairing codes or return sync credentials. Use the existing dashboard pairing flow. Do not create a second registration for the Edge you already registered through the API.
lastSyncAt. ACTIVE means paired, not proof that the device is currently reachable or playing content. Make sure displays can reach the Edge over the branch LAN.
Step 4: Create a Screen assigned to this Edge
After the Edge is paired and active, send POST{{platform_base}}/screens with screens.create:
data.id as screen_id. Channel and Location are optional here; choose their IDs using the Channel guide. Publish Ready content to the selected Channel.
Connect/pair the physical LAN display through the Edge’s supported display setup. Do not use a Cloud Player pairing code for this step. The API assignment itself does not prove the display has connected.
Alternative: move an existing Cloud Screen to Edge
Use POST{{platform_base}}/screens/{{screen_id}}/delivery with screens.delivery:
ACTIVE Edge is required. Pending, disabled, archived or foreign Edge assignment is rejected. A Screen served by another Edge must first follow the supported return-to-Cloud/handover flow. Offline-package Screens cannot change mode this way.
Step 5: Check assigned Screens
Send GET{{platform_base}}/screens?edgeDeviceId={{edge_id}}&limit=25 with screens.read.
Check connection and playback using the Screen guide. Registration, pairing and assignment are separate from content activation on the actual display.
Step 6: List archived Edge records
Send GET{{platform_base}}/edges?archived=true&limit=25.
status=ARCHIVED selects archived records if archived is omitted. Conflicting filters return an empty list. GET /edges/{{edge_id}} can read your archived record as well.
Step 7: Archive an unused Edge
- Check its assigned Screens.
- Return/handover its Screens and Queue operations, and revoke obsolete LAN display assignments through the supported management flow.
- Send DELETE
{{platform_base}}/edges/{{edge_id}}with{}andedges.archive. - Confirm the response has
archived: trueandstatus: "ARCHIVED".
409 resource_in_use, the Edge still has a protected assignment; review it rather than repeatedly retrying archive.
Archiving retains history and revokes cloud sync access. It does not instantly wipe or stop a Windows installation that is disconnected. An archived Edge cannot be paired again or re-enabled; create a new registration with a new name if needed.
Common problems
- 401: check key scopes, expiry, revocation and the issuing account’s permissions.
- 409 quota: review available Edge/Screen capacity.
- 409 duplicate name: choose another name; archived names remain reserved.
- Assignment refused: check ownership,
ACTIVEpairing state and Screen delivery mode. - Pairing code expired: obtain a new code from the dashboard; do not guess or repeatedly retry.

