Deeply API Documentation main logoDeeply API Documentation main logo textDeeply API Documentation main logo text
User GuideServer API Reference
k

Quick Start

API Quick Start Guide
Authorization
Rate Limit

Architecture

Overall Architecture
Edge Server System

Events

Events
Event Categories
List Events
GET
Get An Event
GET

Live Events

Live Events
Listen Live Events
WebSocket

Edges

Edge Server
List Edge Servers
GET
Get An Edge Server
GET
Update Edge Server
PATCH

Microphones

Mic Device
List Mic Devices
GET
Get A Mic Device
GET
Update Mic Device
PATCH

Auth

Reissue Token
GET

© 2025 Deeply Inc.

Deeply Logo Icon

Deeply API Documentation

    1. reference
    2. Edges
    3. List Edge Servers

    List Edge Servers

    Get all edge servers registered in the system

    GET
    /api/v1/edges

    Description

    API to retrieve a list of edge servers. The result is paginated based on the provided query parameters. Refer to Edge Server for more information about the edge object.

    Authentication

    Access Token is required. Refer to Authentication for more information.

    Response

    {
      "results": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "status": "enum(active | inactive)",
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "total_cnt": 100,
      "page": 1,
      "size": 10,
      "max_page": 10
    }

    Request Examples

    Run In Postman

    Simple Request

    const response = await fetch('https://api.example.com/v1/edges?page=1&size=10', {
      method: 'GET',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
      }
    });
    
    const data = await response.json();
    Edge Server
    Get An Edge Server

    On this page

    DescriptionAuthenticationResponseRequest ExamplesSimple Request

    Query Parameters

    page
    optional
    integer || 1
    size
    optional
    integer || 10

    Page number for pagination (must be > 0)

    Number of items per page (must be > 0 and < 101)