Gateway Service
Last updated
Last updated
Get a list of devices.
Pagination start (starts at 1. If not specified, 1 is assumed)
Maximum number of entries to return (if absent, no limit is assumed)
Filter the results
Supply a list of devices comma separated
serial1,serial2,serial3
only serial numbers of full device details
return the number of devices
countOnly=true
Return extra information with the device information
return extended information
serialNumber:a,created:d
return extended information
false
return extended information
false
GET /api/v1/devices HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"devices": [
{
"owner": "123e4567-e89b-12d3-a456-426614174000",
"location": "123e4567-e89b-12d3-a456-426614174000",
"venue": "123e4567-e89b-12d3-a456-426614174000",
"serialNumber": "text",
"deviceType": "AP",
"macAddress": "text",
"manufacturer": "text",
"UUID": 1,
"configuration": "text",
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"createdTimestamp": 1,
"lastConfigurationChange": 1,
"lastConfigurationDownload": 1,
"firmware": "text",
"devicePassword": "text",
"subscriber": "123e4567-e89b-12d3-a456-426614174000",
"entity": "123e4567-e89b-12d3-a456-426614174000",
"modified": 1,
"locale": "text"
}
]
}
Get a list of commands.
Selecting this option means the newest record will be returned. Use limit to select how many.
GET /api/v1/commands HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"commands": [
{
"UUID": "123e4567-e89b-12d3-a456-426614174000",
"command": "text",
"details": "text",
"serialNumber": "text",
"submitted": 1,
"executed": 1,
"completed": 1,
"when": 1,
"errorText": "text",
"results": "text",
"errorCode": 1,
"submittedBy": "text",
"status": "text",
"custom": 1,
"waitingForFile": 1,
"attachFile": 1,
"attachSize": 1,
"attachType": "text"
}
]
}
The requested operation was performed.
DELETE /api/v1/commands HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
Returns a specific command
GET /api/v1/command/{commandUUID} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"UUID": "123e4567-e89b-12d3-a456-426614174000",
"command": "text",
"details": "text",
"serialNumber": "text",
"submitted": 1,
"executed": 1,
"completed": 1,
"when": 1,
"errorText": "text",
"results": "text",
"errorCode": 1,
"submittedBy": "text",
"status": "text",
"custom": 1,
"waitingForFile": 1,
"attachFile": 1,
"attachSize": 1,
"attachType": "text"
}
Delete a specific command
The requested operation was performed.
DELETE /api/v1/command/{commandUUID} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
Retrieve the lists of all default configurations.
GET /api/v1/default_configurations HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"configurations": [
{
"name": "text",
"modelIds": [
"text"
],
"description": "text",
"configuration": "text",
"created": 1,
"lastModified": 1
}
]
}
Retrieve a default configuration.
GET /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"name": "text",
"modelIds": [
"text"
],
"description": "text",
"configuration": "text",
"created": 1,
"lastModified": 1
}
Delete a default default configuration
DELETE /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
Retrieve all the inforamtion about a single device
GET /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"owner": "123e4567-e89b-12d3-a456-426614174000",
"location": "123e4567-e89b-12d3-a456-426614174000",
"venue": "123e4567-e89b-12d3-a456-426614174000",
"serialNumber": "text",
"deviceType": "AP",
"macAddress": "text",
"manufacturer": "text",
"UUID": 1,
"configuration": "text",
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"createdTimestamp": 1,
"lastConfigurationChange": 1,
"lastConfigurationDownload": 1,
"firmware": "text",
"devicePassword": "text",
"subscriber": "123e4567-e89b-12d3-a456-426614174000",
"entity": "123e4567-e89b-12d3-a456-426614174000",
"modified": 1,
"locale": "text"
}
DELETE /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
0=any kind of logs (default) 0=normal logs only 1=crash logs only
Selecting this option means the newest record will be returned. Use limit to select how many.
GET /api/v1/device/{serialNumber}/logs HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"serialNumber": "text",
"values": [
{
"log": "text",
"recorded": 1,
"severity": 1,
"data": "text",
"logType": 1,
"UUID": 1
}
]
}
0=any kind of logs (default) 1=normal logs only 2=crash logs only
The requested operation was performed.
DELETE /api/v1/device/{serialNumber}/logs HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
Selecting this option means the newest record will be returned. Use limit to select how many.
Selecting this option means the last healthcheck will be returned. All other parameters will be ignored.
GET /api/v1/device/{serialNumber}/healthchecks HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"serialNumber": "text",
"values": [
{
"UUID": 1,
"sanity": 1,
"data": "text",
"recorded": 1
}
]
}
The requested operation was performed.
DELETE /api/v1/device/{serialNumber}/healthchecks HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/device/{serialNumber}/capabilities HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"serialNumber": "text",
"capabilities": "text",
"lastUpdate": 1,
"firstUpdate": 1
}
The requested operation was performed.
DELETE /api/v1/device/{serialNumber}/capabilities HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
Selecting this option means the Last Statistics block
Selecting this option means the newest record will be returned. Use limit to select how many.
GET /api/v1/device/{serialNumber}/statistics HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"serialNumber": "text",
"values": [
{
"serialNumber": "text",
"recorded": 1,
"UUID": 1,
"data": "text"
}
]
}
The requested operation was performed.
DELETE /api/v1/device/{serialNumber}/statistics HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/device/{serialNumber}/status HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"serialNumber": "text",
"ipAddress": "text",
"txBytes": 1,
"rxBytes": 1,
"messageCount": 1,
"UUID": 1,
"connected": true,
"lastContact": 1,
"firmware": "text",
"associations_2G": 1,
"associations_5G": 1,
"verifiedCertificate": "NO_CERTIFICATE,"
}
GET /api/v1/ouis HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
GET /api/v1/device/{serialNumber}/rtty HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"serialNumber": "text",
"server": "text",
"port": 1,
"token": "text",
"timeout": 1,
"connectionId": "text",
"started": 1,
"commandUUID": "text",
"viewport": 1,
"password": "text"
}
GET /api/v1/file/{uuid} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
binary
DELETE /api/v1/file/{uuid} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
Get a list of blacklisted devices.
Pagination start (starts at 1. If not specified, 1 is assumed)
Maximum number of entries to return (if absent, no limit is assumed)
Filter the results
GET /api/v1/blacklist HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"devices": [
{
"serialNumber": "text",
"created": 1,
"author": "text",
"reason": "text"
}
]
}
Get a list of blacklisted devices.
Pagination start (starts at 1. If not specified, 1 is assumed)
GET /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"serialNumber": "text",
"created": 1,
"author": "text",
"reason": "text"
}
DELETE /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
GET /api/v1/capabilities HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"device_types": [
{
"deviceType": "text",
"capabilities": "text"
}
]
}
DELETE /api/v1/radiusProxyConfig HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"Operation": "text",
"Details": "text",
"Code": 1
}
GET /api/v1/deviceDashboard HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
No content
10.2.2.2,10.3.4.3
GET /api/v1/iptocountry HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"enabled": true,
"countryCodes": [
"text"
]
}
Get a value
GET /api/v1/system HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Accept: */*
{
"version": "text",
"uptime": 1,
"start": 1,
"os": "text",
"processors": 1,
"hostname": "text",
"certificates": [
{
"filename": "text",
"expires": 1
}
]
}
Create a default configuration.
POST /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 108
{
"name": "text",
"modelIds": [
"text"
],
"description": "text",
"configuration": "text",
"created": 1,
"lastModified": 1
}
{
"Operation": "text",
"Details": "text",
"Code": 1
}
Update a default configuration
PUT /api/v1/default_configuration/{name} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 108
{
"name": "text",
"modelIds": [
"text"
],
"description": "text",
"configuration": "text",
"created": 1,
"lastModified": 1
}
{
"Operation": "text",
"Details": "text",
"Code": 1
}
Definition of uCentral device
AP
Possible values: POST /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 566
{
"owner": "123e4567-e89b-12d3-a456-426614174000",
"location": "123e4567-e89b-12d3-a456-426614174000",
"venue": "123e4567-e89b-12d3-a456-426614174000",
"serialNumber": "text",
"deviceType": "AP",
"macAddress": "text",
"manufacturer": "text",
"UUID": 1,
"configuration": "text",
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"createdTimestamp": 1,
"lastConfigurationChange": 1,
"lastConfigurationDownload": 1,
"firmware": "text",
"devicePassword": "text",
"subscriber": "123e4567-e89b-12d3-a456-426614174000",
"entity": "123e4567-e89b-12d3-a456-426614174000",
"modified": 1,
"locale": "text"
}
{
"owner": "123e4567-e89b-12d3-a456-426614174000",
"location": "123e4567-e89b-12d3-a456-426614174000",
"venue": "123e4567-e89b-12d3-a456-426614174000",
"serialNumber": "text",
"deviceType": "AP",
"macAddress": "text",
"manufacturer": "text",
"UUID": 1,
"configuration": "text",
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"createdTimestamp": 1,
"lastConfigurationChange": 1,
"lastConfigurationDownload": 1,
"firmware": "text",
"devicePassword": "text",
"subscriber": "123e4567-e89b-12d3-a456-426614174000",
"entity": "123e4567-e89b-12d3-a456-426614174000",
"modified": 1,
"locale": "text"
}
Definition of uCentral device
AP
Possible values: PUT /api/v1/device/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 566
{
"owner": "123e4567-e89b-12d3-a456-426614174000",
"location": "123e4567-e89b-12d3-a456-426614174000",
"venue": "123e4567-e89b-12d3-a456-426614174000",
"serialNumber": "text",
"deviceType": "AP",
"macAddress": "text",
"manufacturer": "text",
"UUID": 1,
"configuration": "text",
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"createdTimestamp": 1,
"lastConfigurationChange": 1,
"lastConfigurationDownload": 1,
"firmware": "text",
"devicePassword": "text",
"subscriber": "123e4567-e89b-12d3-a456-426614174000",
"entity": "123e4567-e89b-12d3-a456-426614174000",
"modified": 1,
"locale": "text"
}
{
"owner": "123e4567-e89b-12d3-a456-426614174000",
"location": "123e4567-e89b-12d3-a456-426614174000",
"venue": "123e4567-e89b-12d3-a456-426614174000",
"serialNumber": "text",
"deviceType": "AP",
"macAddress": "text",
"manufacturer": "text",
"UUID": 1,
"configuration": "text",
"notes": [
{
"created": 1,
"createdBy": "text",
"note": "text"
}
],
"createdTimestamp": 1,
"lastConfigurationChange": 1,
"lastConfigurationDownload": 1,
"firmware": "text",
"devicePassword": "text",
"subscriber": "123e4567-e89b-12d3-a456-426614174000",
"entity": "123e4567-e89b-12d3-a456-426614174000",
"modified": 1,
"locale": "text"
}
POST /api/v1/device/{serialNumber}/command HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"command": "text",
"payload": "text",
"when": 1,
"serialNumber": "text"
}
No content
POST /api/v1/device/{serialNumber}/configure HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"serialNumber": "text",
"UUID": 1,
"configuration": "text",
"when": 1
}
No content
POST /api/v1/device/{serialNumber}/ping HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"serialNumber": "text"
}
{
"serialNumber": "text",
"currentUTCTime": 1,
"deviceUTCTime": 1,
"latency": 1,
"configurationUUID": 1
}
POST /api/v1/device/{serialNumber}/upgrade HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 67
{
"uri": "text",
"serialNumber": "text",
"when": 1,
"keepRedirector": true
}
No content
POST /api/v1/device/{serialNumber}/reboot HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"serialNumber": "text",
"when": 1
}
No content
30
0
POST /api/v1/device/{serialNumber}/script HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"serialNumber": "text",
"timeout": 30,
"type": "uci",
"script": "text",
"scriptId": "123e4567-e89b-12d3-a456-426614174000",
"when": 0
}
No content
POST /api/v1/device/{serialNumber}/factory HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"serialNumber": "text",
"when": 1,
"keepRedirector": true
}
No content
only applies to the blink pattern
POST /api/v1/device/{serialNumber}/leds HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"serialNumber": "text",
"when": 1,
"duration": 1,
"pattern": "on"
}
No content
POST /api/v1/device/{serialNumber}/trace HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"serialNumber": "text",
"when": 1,
"duration": 1,
"numberOfPackets": 1,
"network": "text",
"interface": "text"
}
No content
POST /api/v1/device/{serialNumber}/wifiscan HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"serialNumber": "text",
"verbose": true,
"activeScan": true,
"selector": {
"bands": [
"2"
]
},
"ies": [
1
]
}
No content
POST /api/v1/device/{serialNumber}/request HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"serialNumber": "text",
"when": 1,
"message": "state"
}
No content
POST /api/v1/device/{serialNumber}/eventqueue HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"serialNumber": "text",
"types": [
"dhcp"
]
}
No content
false
0 - means to stop streaming, values 1-120 in seconds.
how long should the telemetry run
set to true to start kafka telemetry, false to start websocket telemetry
false
only valid when terminating a stream
POST /api/v1/device/{serialNumber}/telemetry HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 135
{
"serialNumber": "text",
"interval": 1,
"lifetime": 1,
"kafka": false,
"types": [
"dhcp-snooping"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
No content
Pagination start (starts at 1. If not specified, 1 is assumed)
POST /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"serialNumber": "text",
"reason": "text"
}
{
"Operation": "text",
"Details": "text",
"Code": 1
}
Pagination start (starts at 1. If not specified, 1 is assumed)
PUT /api/v1/blacklist/{serialNumber} HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"serialNumber": "text",
"reason": "text"
}
{
"Operation": "text",
"Details": "text",
"Code": 1
}
PUT /api/v1/radiusProxyConfig HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1109
{
"pools": [
{
"name": "text",
"description": "text",
"authConfig": {
"strategy": "random",
"monitor": false,
"monitorMethod": "none",
"methodParameters": [
"text"
],
"servers": [
{
"name": "text",
"ip": "text",
"port": 1,
"weight": 1,
"secret": "text",
"certificate": "text",
"radsec": false,
"radsecPort": 1,
"radsecSecret": "text",
"radsecCacerts": [
"text"
],
"radsecCert": "text",
"radsecKey": "text",
"radsecRealms": [
"text"
],
"ignore": false
}
]
},
"acctConfig": {
"strategy": "random",
"monitor": false,
"monitorMethod": "none",
"methodParameters": [
"text"
],
"servers": [
{
"name": "text",
"ip": "text",
"port": 1,
"weight": 1,
"secret": "text",
"certificate": "text",
"radsec": false,
"radsecPort": 1,
"radsecSecret": "text",
"radsecCacerts": [
"text"
],
"radsecCert": "text",
"radsecKey": "text",
"radsecRealms": [
"text"
],
"ignore": false
}
]
},
"coaConfig": {
"strategy": "random",
"monitor": false,
"monitorMethod": "none",
"methodParameters": [
"text"
],
"servers": [
{
"name": "text",
"ip": "text",
"port": 1,
"weight": 1,
"secret": "text",
"certificate": "text",
"radsec": false,
"radsecPort": 1,
"radsecSecret": "text",
"radsecCacerts": [
"text"
],
"radsecCert": "text",
"radsecKey": "text",
"radsecRealms": [
"text"
],
"ignore": false
}
]
}
}
]
}
No content
POST /api/v1/system HTTP/1.1
Host: localhost:16001
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"command": "setloglevel",
"subsystems": [
{
"tag": "text",
"value": "text"
}
]
}
{
"taglist": [
{
"tag": "text",
"value": "text"
}
]
}