Update Edge Server - v2025.08 - Deeply API Documentation

Archived Version: v2025.08

You are viewing an archived reference version.

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.

Path Parameters

edge_id

Required

string

Unique identifier of the edge server

Request Body

name

Optional

string

Name of the edge server

description

Optional

string

Description of the edge server

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

Update Edge Server Name

Get An Edge Server

Mic Device

Description Authentication Response Request Examples Update Edge Server Name

const response = await fetch('http://{{EDGE_IP}}:8100/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();

Description#

Authentication#

Response#

200Successful Response

Request Examples#

Update Edge Server Name#

Description

Authentication

Response

Request Examples

Update Edge Server Name