Skip to main content
POST
POST /edges
Requires edges.create and an Idempotency-Key. Creates a PENDING Windows Edge registration, not an installation or automatically paired server. Unique workspace name and plan capacity are enforced.
Backend-only. Never enter a real key here. Complete existing authorized dashboard/Windows Edge pairing before assigning Screens.
See Edge registration and lifecycle.

Authorizations

Authorization
string
header
required

Platform API key for one workspace. Create it in Settings with an expiry date or Never expire. Keep it private; use it from Postman or your backend, not browser code. Widget keys are not accepted.

Headers

Idempotency-Key
string
required

An operation ID, not your API key. Generate a UUID for each new change and reuse it when retrying the same request. See https://docs.layarva.com/developers/platform-request-keys for Postman, PowerShell and Node.js examples. Upload instructions are refreshed when requested again.

Pattern: ^[A-Za-z0-9._:-]{1,128}$

Body

application/json

Send application/json using the fields below. JSON requests must be no larger than 64 KiB.

name
string
required
Required string length: 2 - 120
platform
string
default:WINDOWS
Allowed value: "WINDOWS"

Response

Safe live-authorized result

data
object
required