Edge Server API Overview

This section provides an overview of edge server API usage

Edge Server in ArchitectureEdge Server of Deeply AI System
Edge Server of Deeply AI System

Edge Server Object

The Edge Server object represents a server component in the Deeply system architecture that is responsible for handling data processing and communication between edge devices and the central server. This class provides essential information about the edge server, including its unique ID, name, network details, and status.

Attributes

id

  • Type: string
  • Description: A unique identifier for the edge server.

name

  • Type: string
  • Description: The name of the edge server, typically descriptive of its function or location.

description

  • Type: string
  • Description: An optional field for additional details or notes about the server.

host

  • Type: string
  • Description: The hostname or IP address of the edge server. This is used for network identification and communication.

port

  • Type: integer
  • Description: The port number on which the edge server is accessible. This is typically used to establish HTTP or API connections.

status

  • Type: enum(active | inactive)
  • Description: The current operational status of the edge server. Possible values include:
    • "active": The server is online and operational.
    • "inactive": The server is offline or not in use.

created_at

  • Type: string, ISO 8601 format
  • Description: The timestamp indicating when the edge server was initially created in the system. Uses ISO 8601 format.

updated_at

  • Type: string, ISO 8601 format
  • Description: The timestamp of the most recent update to the edge server’s information. Uses ISO 8601 format.

Refer to Get Edge Server API page for detailed response.