vrr/ntopng
2
0
Fork 0
mirror of https://github.com/ntop/ntopng.git synced 2026-05-01 00:19:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update nedge API doc

Browse source
This commit is contained in:
Alfredo Cardigliano 2025-04-01 18:29:54 +02:00
parent 0eac289ecd
commit 6d8b6e74e9
1 changed files with 93 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

93
httpdocs/misc/rest-api-v2-nedge-ext.json
View file

@ -10,6 +10,10 @@
"name": "Interfaces",
"description": "Everything about interfaces"
},
{
"name": "Users",
"description": "Everything about nEdge users"
},
{
"name": "Policy",
"description": "Traffic enforcement policies"
@ -43,6 +47,72 @@
}
}
},
"/lua/pro/rest/v2/get/nedge/gateways/status.lua": {
"get": {
"tags": [
"Interfaces"
],
"summary": "Get gateways status information",
"description": "Read information about gateways",
"operationId": "get_nedge_gateways_status",
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"0": {
"description": "OK"
},
"-3": {
"description": "NOT_GRANTED"
}
}
}
},
"/lua/pro/rest/v2/set/nedge/interface/state.lua": {
"post": {
"tags": [
"Policy"
],
"summary": "Enable or disable a WAN interface",
"description": "Set the state (enabled or disabled) of a WAN interface",
"operationId": "set_nedge_interface_state",
"produces": [
"application/json"
],
"parameters": [
{
"name": "interface",
"in": "formData",
"description": "WAN interface name",
"required": true,
"type": "string"
},
{
"name": "enabled",
"in": "formData",
"description": "New interface enable state: 'true' or 'false'",
"required": true,
"type": "string"
}
],
"responses": {
"0": {
"description": "OK"
},
"-5": {
"description": "INVALID_ARGUMENTS"
},
"-6": {
"description": "INTERNAL_ERROR"
},
"-7": {
"description": "BAD_FORMAT"
}
}
}
},
"/lua/pro/rest/v2/get/nedge/physical/interface/data.lua": {
"get": {
"tags": [
@ -100,6 +170,29 @@
}
}
},
"/lua/pro/rest/v2/get/nedge/gateways/status.lua": {
"get": {
"tags": [
"Users"
],
"summary": "Get users stats",
"description": "Read traffic stats about users",
"operationId": "get_nedge_users_status",
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"0": {
"description": "OK"
},
"-3": {
"description": "NOT_GRANTED"
}
}
}
},
"/lua/pro/rest/v2/get/nedge/policy/default.lua": {
"get": {
"tags": [