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. Update Edge Server

    Update Edge Server

    Update specific edge server details by its ID

    PATCH
    /api/v1/edges/{edge_id}

    Description

    API to update a specific edge server's details by its ID. Refer to Edge Server for more information about the edge object.

    Authentication

    Access Token is required via Bearer token authentication. Refer to Authentication for more information.

    Response

    {
      "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "status": "active",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      }
    }

    Request Examples

    Run In Postman

    Update Edge Server Name

    const response = await fetch('https://openapi.deeplyinc.com/api/v1/edges/edge_123', {
      method: 'PATCH',
      headers: {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        "name": "New Edge Server Name"
      })
    });
    
    const data = await response.json();
    Get An Edge Server
    Mic Device

    On this page

    DescriptionAuthenticationResponseRequest ExamplesUpdate Edge Server Name

    Path Parameters

    Request Body

    edge_id
    required
    string
    name
    optional
    string
    description
    optional
    string

    Unique identifier of the edge server

    Name of the edge server

    Description of the edge server