> ## Documentation Index
> Fetch the complete documentation index at: https://docs.layarva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /edges/{id}

> Owned Edge detail, including archived inventory; no credentials or pairing codes. Required permissions: edges.read. Use Postman or your backend. Keep your API key private; do not enter it in this public documentation page.

Requires `edges.read`. Returns only an owned Edge, including archived inventory. Detail endpoints do not accept query parameters.

> [!NOTE]
>
> Backend-only. Never enter a real key here. ACTIVE means paired, not proof of recent liveness or physical playback.

See [Edge registration and lifecycle](https://docs.layarva.com/developers/platform-edges.md).


## OpenAPI

````yaml api/platform-workspace.openapi.json GET /edges/{id}
openapi: 3.1.0
info:
  title: Layarva Platform / Workspace API
  version: 1.1.0
  description: >-
    Manage Library, Playlists, Channels, Locations, Edges, Screens and
    Schedules. Use a Platform key, not a Widget key. See
    https://docs.layarva.com/developers/platform-quickstart. Upload supported
    files, export eligible offline packages and receive signed Platform
    webhooks. Permissions, plan limits and publishing rules apply. If a request
    returns 503, stop that workflow and contact support with its requestId.
servers:
  - url: https://api.layarva.com/api/platform/v1/workspaces/{workspaceId}
    variables:
      workspaceId:
        default: workspace_example
security:
  - PlatformBearer: []
paths:
  /edges/{id}:
    get:
      tags:
        - edges
      summary: GET /edges/{id}
      description: >-
        Owned Edge detail, including archived inventory; no credentials or
        pairing codes. Required permissions: edges.read. Use Postman or your
        backend. Keep your API key private; do not enter it in this public
        documentation page.
      operationId: get__edges_id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
      responses:
        '200':
          description: Safe live-authorized result
          headers:
            X-Request-Id:
              schema:
                type: string
            Cache-Control:
              schema:
                const: private, no-store
            X-RateLimit-Limit:
              schema:
                type: string
            X-RateLimit-Remaining:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Edge'
                required:
                  - data
                additionalProperties: false
        default:
          description: >-
            Error with code, message and requestId. Follow Retry-After when
            present. Contact support with the requestId if the problem
            continues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            X-Request-Id:
              schema:
                type: string
            Retry-After:
              schema:
                type: string
components:
  schemas:
    Id:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: string
      pattern: ^[A-Za-z0-9_-]{1,100}$
    Edge:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        platform:
          type: string
        status:
          enum:
            - PENDING
            - ACTIVE
            - DISABLED
            - ARCHIVED
        lanAddress:
          anyOf:
            - type: string
            - type: 'null'
        lanPort:
          type: number
        lanAddressIsStatic:
          type: boolean
        appVersion:
          anyOf:
            - type: string
            - type: 'null'
        clockTrusted:
          type: boolean
        lastSyncAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - platform
        - status
        - lanAddress
        - lanPort
        - lanAddressIsStatic
        - appVersion
        - clockTrusted
        - lastSyncAt
        - createdAt
        - updatedAt
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    PlatformBearer:
      type: http
      scheme: bearer
      bearerFormat: lv_platform_<43 base64url characters>
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.