API docs by Redocly

Edge-API (1.0.0)

Download OpenAPI specification:Download

The Edge-API is responsible for interfacing with the Edge-Wi-Fi-Controller to allow for config functionality and status reports over an HTTP REST API. The Edge-API enforces authorization and permissions for these operations.

Login

Authenticates a user and generates a JWT API key.

Authorizations:
cookieAuth
Request Body schema: application/json
email
required
string <email>

User's email address.

password
required
string

User's password.

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "apiKey": "string"
}

List Users

Retrieves a list of all registered users.

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Networks

Retrieves a list of all configured networks with client information.

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Network

Creates a new network.

Authorizations:
cookieAuth
Request Body schema: application/json
name
required
string

Name of the new network.

type
required
string
Enum: "guest" "business"

Type of the network (guest or business).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "guest"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "guest",
  • "total_clients": 0,
  • "authenticated_clients": 0,
  • "online_clients": 0,
  • "offline_clients": 0,
  • "total_download": 0,
  • "total_upload": 0
}

Network Details

Retrieves detailed information about a specific network.

Authorizations:
cookieAuth
path Parameters
network_id
required
string <uuid>

The UUID of the network.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "guest",
  • "total_clients": 0,
  • "authenticated_clients": 0,
  • "online_clients": 0,
  • "offline_clients": 0,
  • "total_download": 0,
  • "total_upload": 0
}

Delete Network

Deletes a network.

Authorizations:
cookieAuth
path Parameters
network_id
required
string <uuid>

The UUID of the network to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get Guest Network Password

Retrieves the password for a guest network.

Authorizations:
cookieAuth
path Parameters
network_id
required
string <uuid>

The UUID of the network.

Responses

Response samples

Content type
application/json
{
  • "password": "string"
}

List Devices (by Network)

Retrieves a list of devices connected to a specific network.

Authorizations:
cookieAuth
path Parameters
network_id
required
string <uuid>

The UUID of the network.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add Device

Adds a new device to a specified network.

Authorizations:
cookieAuth
path Parameters
network_id
required
string <uuid>

The UUID of the network to add the device to.

Request Body schema: application/json
name
required
string

Name of the new device.

type
required
string
Enum: "phone" "laptop" "pc" "printer" "iot"

Type of the device.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "phone"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "phone",
  • "password": "string",
  • "mac": "string",
  • "ip": "string",
  • "currentAP": "976e82e8-88f6-48e5-9d54-0a8ce3dff654",
  • "currentAP_name": "string",
  • "addedBy": "e7b73b51-b147-4481-bcc4-0ec1394b652e",
  • "addedAt": "2019-08-24T14:15:22Z",
  • "firstConnectedAt": "2019-08-24T14:15:22Z",
  • "lastConnectedAt": "2019-08-24T14:15:22Z",
  • "network": "d72f4655-059b-4c8a-bb9d-87f2df3b2fcf",
  • "online": true,
  • "last_checked_at": "2019-08-24T14:15:22Z",
  • "auth": true,
  • "authorized": true,
  • "signal": 0,
  • "bytes_rx": 0,
  • "bytes_tx": 0,
  • "packets_rx": 0,
  • "packets_tx": 0,
  • "rate_rx": 0,
  • "rate_tx": 0
}

List Devices (All)

Retrieves a list of all devices across all networks.

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Device Details (No Network Context)

Retrieves details for a specific device without specifying a network.

Authorizations:
cookieAuth
path Parameters
device_id
required
string <uuid>

The UUID of the device.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "type": "phone",
  • "password": "string",
  • "mac": "string",
  • "ip": "string",
  • "currentAP": "976e82e8-88f6-48e5-9d54-0a8ce3dff654",
  • "currentAP_name": "string",
  • "addedBy": "e7b73b51-b147-4481-bcc4-0ec1394b652e",
  • "addedAt": "2019-08-24T14:15:22Z",
  • "firstConnectedAt": "2019-08-24T14:15:22Z",
  • "lastConnectedAt": "2019-08-24T14:15:22Z",
  • "network": "d72f4655-059b-4c8a-bb9d-87f2df3b2fcf",
  • "online": true,
  • "last_checked_at": "2019-08-24T14:15:22Z",
  • "auth": true,
  • "authorized": true,
  • "signal": 0,
  • "bytes_rx": 0,
  • "bytes_tx": 0,
  • "packets_rx": 0,
  • "packets_tx": 0,
  • "rate_rx": 0,
  • "rate_tx": 0
}

Remove Device (No Network Context)

Removes a device.

Authorizations:
cookieAuth
path Parameters
device_id
required
string <uuid>

The UUID of the device to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List Access Points

Retrieves a list of all detected Access Points.

Authorizations:
cookieAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Access Point Details

Retrieves detailed information about a specific Access Point.

Authorizations:
cookieAuth
path Parameters
ap_id
required
string <uuid>

The UUID of the Access Point.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mac": "string",
  • "firstConnectedAt": "2019-08-24T14:15:22Z",
  • "lastConnectedAt": "2019-08-24T14:15:22Z",
  • "meshConnections": [
    ],
  • "connectedDevices": 0,
  • "online": true,
  • "signal": 0
}