Datasance PoT-ioFog Controller (1.0.0)
Download OpenAPI specification:Download
Returns list of ioFog nodes
Authorizations:
Request Body schema: application/json
key | string |
value | string |
condition | string |
Responses
Request samples
- Payload
[- {
- "key": "string",
- "value": "string",
- "condition": "string"
}
]
Response samples
- 200
{- "fogs": [
- {
- "lastActive": 0,
- "daemonOperatingDuration": 0,
- "daemonLastStart": 0,
- "repositoryCount": 0,
- "systemTime": 0,
- "lastStatusTime": 0,
- "processedMessages": 0,
- "lastCommandTime": 0,
- "logFileCount": 0,
- "uuid": "string",
- "name": "string",
- "location": "string",
- "gpsMode": "string",
- "latitude": 0,
- "longitude": 0,
- "description": "string",
- "daemonStatus": "string",
- "memoryUsage": 0,
- "diskUsage": 0,
- "cpuUsage": 0,
- "memoryViolation": true,
- "diskViolation": true,
- "cpuViolation": true,
- "systemTotalCpu": 0,
- "catalogItemStatus": "string",
- "repositoryStatus": "string",
- "ipAddress": "string",
- "ipAddressExternal": "string",
- "catalogItemMessageCounts": 0,
- "messageSpeed": 0,
- "networkInterface": "string",
- "dockerUrl": "string",
- "diskLimit": 0,
- "diskDirectory": "string",
- "memoryLimit": 0,
- "cpuLimit": 0,
- "logLimit": 0,
- "logDirectory": "string",
- "bluetoothEnabled": true,
- "abstractedHardwareEnabled": true,
- "version": "string",
- "isReadyToUpgrade": true,
- "isReadyToRollback": true,
- "statusFrequency": 0,
- "changeFrequency": 0,
- "deviceScanFrequency": 0,
- "tunnel": "string",
- "watchdogEnabled": true,
- "dockerPruningFrequency": 0,
- "availableDiskThreshold": 0,
- "logLevel": "string",
- "isSystem": true,
- "routerId": 0,
- "createAt": 0,
- "updatedAt": 0,
- "fogTypeId": 0,
- "routerMode": "none",
- "messagingPort": 0,
- "upstreamRouters": [
- "string"
]
}
]
}
Creates a new ioFog node
Authorizations:
Request Body schema: application/jsonrequired
name | string |
location | string |
latitude | number |
longitude | number |
description | string |
dockerUrl | string Default: "unix:///var/run/docker.sock" |
diskLimit | number Default: 50 |
diskDirectory | string Default: "/var/lib/iofog" |
memoryLimit | number <MB> Default: 4096 |
cpuLimit | number <percent> Default: 80 |
logLimit | number <GB> Default: 10 |
logDirectory | string Default: "/var/log/iofog" |
logFileCount | number Default: 10 |
statusFrequency | number <seconds> Default: 10 |
changeFrequency | number <seconds> Default: 20 |
deviceScanFrequency | number <seconds> Default: 20 |
bluetoothEnabled | boolean Default: false |
watchdogEnabled | boolean Default: true |
abstractedHardwareEnabled | boolean Default: false |
fogType | number |
dockerPruningFrequency | number |
availableDiskThreshold | number |
logLevel | string Default: "info" |
isSystem | boolean |
routerMode | string Default: "edge" Enum: "none" "edge" "interior" |
messagingPort | number |
interRouterPort | number |
edgeRouterPort | number |
host | string |
tags | Array of strings |
upstreamRouters | Array of strings |
networkRouter | string |
Responses
Request samples
- Payload
{- "name": "string",
- "location": "string",
- "latitude": 0,
- "longitude": 0,
- "description": "string",
- "dockerUrl": "unix:///var/run/docker.sock",
- "diskLimit": 50,
- "diskDirectory": "/var/lib/iofog",
- "memoryLimit": 4096,
- "cpuLimit": 80,
- "logLimit": 10,
- "logDirectory": "/var/log/iofog",
- "logFileCount": 10,
- "statusFrequency": 10,
- "changeFrequency": 20,
- "deviceScanFrequency": 20,
- "bluetoothEnabled": false,
- "watchdogEnabled": true,
- "abstractedHardwareEnabled": false,
- "fogType": 0,
- "dockerPruningFrequency": 0,
- "availableDiskThreshold": 0,
- "logLevel": "info",
- "isSystem": true,
- "routerMode": "none",
- "messagingPort": 0,
- "interRouterPort": 0,
- "edgeRouterPort": 0,
- "host": "string",
- "tags": [
- "string"
], - "upstreamRouters": [
- "string"
], - "networkRouter": "string"
}
Response samples
- 201
{- "id": "string"
}
Updates existing ioFog node
Authorizations:
path Parameters
uuid required | string ioFog node id |
Request Body schema: application/jsonrequired
name | string |
location | string |
latitude | number |
longitude | number |
description | string |
dockerUrl | string Default: "unix:///var/run/docker.sock" |
diskLimit | number Default: 50 |
diskDirectory | string Default: "/var/lib/iofog" |
memoryLimit | number <MB> Default: 4096 |
cpuLimit | number <percent> Default: 80 |
logLimit | number <GB> Default: 10 |
logDirectory | string Default: "/var/log/iofog" |
logFileCount | number Default: 10 |
statusFrequency | number <seconds> Default: 10 |
changeFrequency | number <seconds> Default: 20 |
deviceScanFrequency | number <seconds> Default: 20 |
bluetoothEnabled | boolean Default: false |
watchdogEnabled | boolean Default: true |
abstractedHardwareEnabled | boolean Default: false |
fogType | number |
dockerPruningFrequency | number |
availableDiskThreshold | number |
logLevel | string Default: "info" |
isSystem | boolean |
routerMode | string Default: "edge" Enum: "none" "edge" "interior" |
messagingPort | number |
interRouterPort | number |
edgeRouterPort | number |
host | string |
tags | Array of strings |
upstreamRouters | Array of strings |
networkRouter | string |
Responses
Request samples
- Payload
{- "name": "string",
- "location": "string",
- "latitude": 0,
- "longitude": 0,
- "description": "string",
- "dockerUrl": "unix:///var/run/docker.sock",
- "diskLimit": 50,
- "diskDirectory": "/var/lib/iofog",
- "memoryLimit": 4096,
- "cpuLimit": 80,
- "logLimit": 10,
- "logDirectory": "/var/log/iofog",
- "logFileCount": 10,
- "statusFrequency": 10,
- "changeFrequency": 20,
- "deviceScanFrequency": 20,
- "bluetoothEnabled": false,
- "watchdogEnabled": true,
- "abstractedHardwareEnabled": false,
- "fogType": 0,
- "dockerPruningFrequency": 0,
- "availableDiskThreshold": 0,
- "logLevel": "info",
- "isSystem": true,
- "routerMode": "none",
- "messagingPort": 0,
- "interRouterPort": 0,
- "edgeRouterPort": 0,
- "host": "string",
- "tags": [
- "string"
], - "upstreamRouters": [
- "string"
], - "networkRouter": "string"
}
Gets ioFog node info
Authorizations:
path Parameters
uuid required | string ioFog node id |
Responses
Response samples
- 200
{- "lastActive": 0,
- "daemonOperatingDuration": 0,
- "daemonLastStart": 0,
- "repositoryCount": 0,
- "systemTime": 0,
- "lastStatusTime": 0,
- "processedMessages": 0,
- "lastCommandTime": 0,
- "logFileCount": 0,
- "uuid": "string",
- "name": "string",
- "location": "string",
- "gpsMode": "string",
- "latitude": 0,
- "longitude": 0,
- "description": "string",
- "daemonStatus": "string",
- "memoryUsage": 0,
- "diskUsage": 0,
- "cpuUsage": 0,
- "memoryViolation": true,
- "diskViolation": true,
- "cpuViolation": true,
- "systemTotalCpu": 0,
- "catalogItemStatus": "string",
- "repositoryStatus": "string",
- "ipAddress": "string",
- "ipAddressExternal": "string",
- "catalogItemMessageCounts": 0,
- "messageSpeed": 0,
- "networkInterface": "string",
- "dockerUrl": "string",
- "diskLimit": 0,
- "diskDirectory": "string",
- "memoryLimit": 0,
- "cpuLimit": 0,
- "logLimit": 0,
- "logDirectory": "string",
- "bluetoothEnabled": true,
- "abstractedHardwareEnabled": true,
- "version": "string",
- "isReadyToUpgrade": true,
- "isReadyToRollback": true,
- "statusFrequency": 0,
- "changeFrequency": 0,
- "deviceScanFrequency": 0,
- "tunnel": "string",
- "watchdogEnabled": true,
- "dockerPruningFrequency": 0,
- "availableDiskThreshold": 0,
- "logLevel": "string",
- "isSystem": true,
- "routerId": 0,
- "createAt": 0,
- "updatedAt": 0,
- "fogTypeId": 0,
- "routerMode": "none",
- "messagingPort": 0,
- "upstreamRouters": [
- "string"
]
}
Response samples
- 200
{- "applications": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "isActivated": true,
- "microservices": [
- {
- "microservices": [
- {
- "uuid": "string",
- "name": "string",
- "config": "string",
- "rootHostAccess": true,
- "logLimit": 0,
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": "string"
}
], - "iofogUuid": "string",
- "envs": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "volumeMappings": [
- {
- "id": 0,
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw",
- "type": "bind"
}
], - "ports": [
- {
- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
], - "status": {
- "status": "string",
- "operatingDuration": 0,
- "startTime": 0,
- "cpuUsage": 0,
- "memoryUsage": 0,
- "containerId": "string"
}
}
]
}
], - "routes": [
- {
- "name": "string",
- "from": "string",
- "to": "string"
}
]
}
]
}
Response samples
- 200
{- "applications": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "isActivated": true,
- "microservices": [
- {
- "microservices": [
- {
- "uuid": "string",
- "name": "string",
- "config": "string",
- "rootHostAccess": true,
- "logLimit": 0,
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": "string"
}
], - "iofogUuid": "string",
- "envs": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "volumeMappings": [
- {
- "id": 0,
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw",
- "type": "bind"
}
], - "ports": [
- {
- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
], - "status": {
- "status": "string",
- "operatingDuration": 0,
- "startTime": 0,
- "cpuUsage": 0,
- "memoryUsage": 0,
- "containerId": "string"
}
}
]
}
], - "routes": [
- {
- "name": "string",
- "from": "string",
- "to": "string"
}
]
}
]
}
Updates an application metadata
Authorizations:
path Parameters
name required | string Application name |
Request Body schema: application/jsonrequired
name | string |
description | string |
isActivated | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "isActivated": true
}
Gets an application details
Authorizations:
path Parameters
name required | string Application name |
Responses
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "isActivated": true,
- "microservices": [
- {
- "microservices": [
- {
- "uuid": "string",
- "name": "string",
- "config": "string",
- "rootHostAccess": true,
- "logLimit": 0,
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": "string"
}
], - "iofogUuid": "string",
- "envs": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "volumeMappings": [
- {
- "id": 0,
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw",
- "type": "bind"
}
], - "ports": [
- {
- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
], - "status": {
- "status": "string",
- "operatingDuration": 0,
- "startTime": 0,
- "cpuUsage": 0,
- "memoryUsage": 0,
- "containerId": "string"
}
}
]
}
], - "routes": [
- {
- "name": "string",
- "from": "string",
- "to": "string"
}
]
}
Response samples
- 200
{- "applicationTemplates": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "application": {
- "microservices": [
- {
- "microservices": [
- {
- "uuid": "string",
- "name": "string",
- "config": "string",
- "rootHostAccess": true,
- "logLimit": 0,
- "images": [
- {
- "containerImage": null,
- "fogTypeId": null
}
], - "iofogUuid": "string",
- "envs": [
- {
- "key": null,
- "value": null
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "volumeMappings": [
- {
- "id": null,
- "hostDestination": null,
- "containerDestination": null,
- "accessMode": null,
- "type": null
}
], - "ports": [
- {
- "internal": null,
- "external": null,
- "protocol": null,
- "proxy": null
}
], - "status": {
- "status": "string",
- "operatingDuration": 0,
- "startTime": 0,
- "cpuUsage": 0,
- "memoryUsage": 0,
- "containerId": "string"
}
}
]
}
], - "routes": [
- {
- "name": "string",
- "from": "string",
- "to": "string"
}
]
}
}
]
}
Gets an application template
Authorizations:
path Parameters
name required | string Application template name |
Responses
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "application": {
- "microservices": [
- {
- "microservices": [
- {
- "uuid": "string",
- "name": "string",
- "config": "string",
- "rootHostAccess": true,
- "logLimit": 0,
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": "string"
}
], - "iofogUuid": "string",
- "envs": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "volumeMappings": [
- {
- "id": 0,
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw",
- "type": "bind"
}
], - "ports": [
- {
- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
], - "status": {
- "status": "string",
- "operatingDuration": 0,
- "startTime": 0,
- "cpuUsage": 0,
- "memoryUsage": 0,
- "containerId": "string"
}
}
]
}
], - "routes": [
- {
- "name": "string",
- "from": "string",
- "to": "string"
}
]
}
}
Response samples
- 200
{- "catalogItems": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "category": "string",
- "publisher": "string",
- "diskRequired": 0,
- "ramRequired": 0,
- "picture": "string",
- "isPublic": true,
- "registryId": 0,
- "inputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "outputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "configExample": "string",
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": 1
}
]
}
]
}
Creates a new microservice catalog item
Authorizations:
Request Body schema: application/jsonrequired
Microservice Catalog Item Info
name | string |
description | string |
category | string |
Array of objects (MicroserviceContainerImages) | |
publisher | string |
diskRequired | number |
ramRequired | number |
picture | string |
isPublic | boolean |
registryId | number |
object (InfoTypeResponse) | |
object (InfoTypeResponse) | |
configExample | string |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "category": "string",
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": 1
}
], - "publisher": "string",
- "diskRequired": 0,
- "ramRequired": 0,
- "picture": "string",
- "isPublic": true,
- "registryId": 0,
- "inputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "outputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "configExample": "string"
}
Response samples
- 201
{- "id": "string"
}
Gets microservice catalog item info
Authorizations:
path Parameters
id required | string Catalog Item Id |
Responses
Response samples
- 200
{- "id": "string",
- "name": "string",
- "description": "string",
- "category": "string",
- "publisher": "string",
- "diskRequired": 0,
- "ramRequired": 0,
- "picture": "string",
- "isPublic": true,
- "registryId": 0,
- "inputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "outputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "configExample": "string",
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": 1
}
]
}
Updates a microservice catalog item
Authorizations:
path Parameters
id required | string Catalog Item Id |
Request Body schema: application/jsonrequired
Microservice Catalog Item Info
name | string |
description | string |
category | string |
Array of objects (MicroserviceContainerImages) | |
publisher | string |
diskRequired | number |
ramRequired | number |
picture | string |
isPublic | boolean |
registryId | number |
object (InfoTypeResponse) | |
object (InfoTypeResponse) | |
configExample | string |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "category": "string",
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": 1
}
], - "publisher": "string",
- "diskRequired": 0,
- "ramRequired": 0,
- "picture": "string",
- "isPublic": true,
- "registryId": 0,
- "inputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "outputType": {
- "infoType": "string",
- "infoFormat": "string"
}, - "configExample": "string"
}
Creates new registry
Authorizations:
Request Body schema: application/json
url | string |
isPublic | boolean |
username | string |
password | string |
string | |
requiresCert | boolean |
certificate | string |
Responses
Request samples
- Payload
{- "url": "string",
- "isPublic": true,
- "username": "string",
- "password": "string",
- "email": "string",
- "requiresCert": true,
- "certificate": "string"
}
Updates a registry
Authorizations:
path Parameters
id required | string Registry id |
Request Body schema: application/jsonrequired
url | string |
isPublic | boolean |
username | string |
password | string |
string | |
requiresCert | boolean |
certificate | string |
Responses
Request samples
- Payload
{- "url": "string",
- "isPublic": true,
- "username": "string",
- "password": "string",
- "email": "string",
- "requiresCert": true,
- "certificate": "string"
}
Gets list of microservices
Authorizations:
query Parameters
flowId | integer Deprecated Flow Id |
application | string Application name |
Responses
Response samples
- 200
{- "microservices": [
- {
- "uuid": "string",
- "name": "string",
- "config": "string",
- "rootHostAccess": true,
- "logLimit": 0,
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": "string"
}
], - "iofogUuid": "string",
- "envs": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "volumeMappings": [
- {
- "id": 0,
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw",
- "type": "bind"
}
], - "ports": [
- {
- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
], - "status": {
- "status": "string",
- "operatingDuration": 0,
- "startTime": 0,
- "cpuUsage": 0,
- "memoryUsage": 0,
- "containerId": "string"
}
}
]
}
Gets a microservice info
Authorizations:
path Parameters
uuid required | string Microservice Uuid |
Responses
Response samples
- 200
{- "uuid": "string",
- "name": "string",
- "config": "string",
- "rootHostAccess": true,
- "logLimit": 0,
- "images": [
- {
- "containerImage": "string",
- "fogTypeId": "string"
}
], - "iofogUuid": "string",
- "envs": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "volumeMappings": [
- {
- "id": 0,
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw",
- "type": "bind"
}
], - "ports": [
- {
- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
], - "status": {
- "status": "string",
- "operatingDuration": 0,
- "startTime": 0,
- "cpuUsage": 0,
- "memoryUsage": 0,
- "containerId": "string"
}
}
Creates a port mapping for microservice
Authorizations:
path Parameters
uuid required | string Microservice Uuid |
Request Body schema: application/jsonrequired
information about port mapping
internal required | number |
external required | number |
protocol | string Enum: "tcp" "udp" |
proxy | boolean |
Responses
Request samples
- Payload
{- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
Response samples
- 201
{- "publicIp": "string",
- "publicPort": 0
}
Creates a port mapping for system microservice
Authorizations:
path Parameters
uuid required | string Microservice Uuid |
Request Body schema: application/jsonrequired
information about port mapping
internal required | number |
external required | number |
protocol | string Enum: "tcp" "udp" |
proxy | boolean |
Responses
Request samples
- Payload
{- "internal": 0,
- "external": 0,
- "protocol": "tcp",
- "proxy": true
}
Response samples
- 201
{- "publicIp": "string",
- "publicPort": 0
}
Creates a volume mapping for microservice
Authorizations:
path Parameters
uuid required | string Microservice Uuid |
Request Body schema: application/jsonrequired
information about volume mapping
hostDestination | string |
containerDestination | string |
accessMode | string |
Responses
Request samples
- Payload
{- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw"
}
Response samples
- 201
{- "id": 0
}
Get a volume mapping list for microservice
Authorizations:
path Parameters
uuid required | string Microservice Uuid |
Responses
Response samples
- 200
{- "volumeMappings": [
- {
- "id": 0,
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw",
- "type": "bind"
}
]
}
Creates a volume mapping for system microservice
Authorizations:
path Parameters
uuid required | string Microservice Uuid |
Request Body schema: application/jsonrequired
information about volume mapping
hostDestination | string |
containerDestination | string |
accessMode | string |
Responses
Request samples
- Payload
{- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw"
}
Response samples
- 201
{- "id": 0
}
Creates a new route
Authorizations:
Request Body schema: application/jsonrequired
Route Info
name required | string |
sourceMicroserviceUuid required | string |
destMicroserviceUuid required | string |
Responses
Request samples
- Payload
{- "name": "string",
- "sourceMicroserviceUuid": "string",
- "destMicroserviceUuid": "string"
}
Response samples
- 201
{- "id": "string"
}
Updates a route
Authorizations:
path Parameters
name required | string Route name |
Request Body schema: application/jsonrequired
Route Info
name | string |
sourceMicroserviceUuid | string |
destMicroserviceUuid | string |
Responses
Request samples
- Payload
{- "name": "string",
- "sourceMicroserviceUuid": "string",
- "destMicroserviceUuid": "string"
}
Get Specific Edge Resource
Authorizations:
path Parameters
name required | string Edge Resource name |
version required | string Edge Resource version |
Responses
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "version": "string",
- "interfaceProtocol": "string",
- "display": {
- "color": "string",
- "icon": "string",
- "name": "string"
}, - "interface": {
- "endpoints": [
- {
- "name": 0,
- "description": 0,
- "method": "string",
- "url": "string",
- "requestType": "string",
- "responseType": "string",
- "requestPayloadExample": "string",
- "responsePayloadExample": "string"
}
]
}, - "custom": { }
}
Update/Create Specific Edge Resource
Authorizations:
path Parameters
name required | string Edge Resource name |
version required | string Edge Resource version |
Request Body schema: application/jsonrequired
Updated profile data
name | string |
description | string |
version | string |
interfaceProtocol | string |
object (EdgeResourceDisplay) | |
object (EdgeResourceHTTPInterface) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "version": "string",
- "interfaceProtocol": "string",
- "display": {
- "color": "string",
- "icon": "string",
- "name": "string"
}, - "interface": {
- "endpoints": [
- {
- "name": 0,
- "description": 0,
- "method": "string",
- "url": "string",
- "requestType": "string",
- "responseType": "string",
- "requestPayloadExample": "string",
- "responsePayloadExample": "string"
}
]
}
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "version": "string",
- "interfaceProtocol": "string",
- "display": {
- "color": "string",
- "icon": "string",
- "name": "string"
}, - "interface": {
- "endpoints": [
- {
- "name": 0,
- "description": 0,
- "method": "string",
- "url": "string",
- "requestType": "string",
- "responseType": "string",
- "requestPayloadExample": "string",
- "responsePayloadExample": "string"
}
]
}, - "custom": { }
}
Get Specific Edge Resource versions
Authorizations:
path Parameters
name required | string Edge Resource name |
Responses
Response samples
- 200
{- "edgeResources": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "version": "string",
- "interfaceProtocol": "string",
- "display": {
- "color": "string",
- "icon": "string",
- "name": "string"
}
}
]
}
Create Specific Edge Resource
Authorizations:
Request Body schema: application/jsonrequired
Updated profile data
name | string |
description | string |
version | string |
interfaceProtocol | string |
object (EdgeResourceDisplay) | |
object (EdgeResourceHTTPInterface) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "version": "string",
- "interfaceProtocol": "string",
- "display": {
- "color": "string",
- "icon": "string",
- "name": "string"
}, - "interface": {
- "endpoints": [
- {
- "name": 0,
- "description": 0,
- "method": "string",
- "url": "string",
- "requestType": "string",
- "responseType": "string",
- "requestPayloadExample": "string",
- "responsePayloadExample": "string"
}
]
}
}
Response samples
- 200
{- "id": 0,
- "name": "string",
- "description": "string",
- "version": "string",
- "interfaceProtocol": "string",
- "display": {
- "color": "string",
- "icon": "string",
- "name": "string"
}, - "interface": {
- "endpoints": [
- {
- "name": 0,
- "description": 0,
- "method": "string",
- "url": "string",
- "requestType": "string",
- "responseType": "string",
- "requestPayloadExample": "string",
- "responsePayloadExample": "string"
}
]
}, - "custom": { }
}
Attach Edge Resource to Agent
Authorizations:
path Parameters
name required | string Edge Resource Name |
version required | string Edge Resource Version |
Request Body schema: application/jsonrequired
Agent informations
uuid | string |
Responses
Request samples
- Payload
{- "uuid": "string"
}
Detach Edge Resource from Agent
Authorizations:
path Parameters
name required | string Edge Resource Name |
version required | string Edge Resource Version |
Request Body schema: application/jsonrequired
Agent informations
uuid | string |
Responses
Request samples
- Payload
{- "uuid": "string"
}
Posts Microservice Strace file to FTP
Authorizations:
path Parameters
uuid required | string Microservice UUID |
Request Body schema: application/jsonrequired
ftpHost | string |
ftpPort | number |
ftpUser | string |
ftpPass | string |
ftpDestDir | string |
Responses
Request samples
- Payload
{- "ftpHost": "string",
- "ftpPort": 0,
- "ftpUser": "string",
- "ftpPass": "string",
- "ftpDestDir": "string"
}
Provision agent with an ioFog node
Request Body schema: application/jsonrequired
type required | number Enum: 1 2 Architecture
|
key required | string provisioning key |
Responses
Request samples
- Payload
{- "type": 1,
- "key": "string"
}
Response samples
- 200
{- "id": "string",
- "token": "string"
}
Response samples
- 200
{- "networkInterface": "string",
- "dockerUrl": "string",
- "diskLimit": 0,
- "diskDirectory": "string",
- "memoryLimit": 0,
- "cpuLimit": 0,
- "logLimit": 0,
- "logDirectory": "string",
- "logFileCount": 0,
- "statusFrequency": 0,
- "changeFrequency": 0,
- "deviceScanFrequency": 0,
- "watchdogEnabled": true,
- "latitude": 0,
- "longitude": 0,
- "logLevel": "string",
- "availableDiskThreshold": 0,
- "dockerPruningFrequency": 0,
- "routerHost": "string",
- "routerPort": 0
}
Updates an ioFog node configuration
Authorizations:
Request Body schema: application/jsonrequired
networkInterface | string |
dockerUrl | string |
diskLimit | number |
diskDirectory | string |
memoryLimit | number |
cpuLimit | number |
logLimit | number |
logDirectory | string |
logFileCount | number |
statusFrequency | number |
changeFrequency | number |
deviceScanFrequency | number |
watchdogEnabled | boolean |
latitude | number |
longitude | number |
gpsMode | string |
logLevel | string |
availableDiskThreshold | number |
dockerPruningFrequency | number |
Responses
Request samples
- Payload
{- "networkInterface": "string",
- "dockerUrl": "string",
- "diskLimit": 0,
- "diskDirectory": "string",
- "memoryLimit": 0,
- "cpuLimit": 0,
- "logLimit": 0,
- "logDirectory": "string",
- "logFileCount": 0,
- "statusFrequency": 0,
- "changeFrequency": 0,
- "deviceScanFrequency": 0,
- "watchdogEnabled": true,
- "latitude": 0,
- "longitude": 0,
- "gpsMode": "string",
- "logLevel": "string",
- "availableDiskThreshold": 0,
- "dockerPruningFrequency": 0
}
Response samples
- 200
{- "config": true,
- "version": true,
- "reboot": true,
- "deleteNode": true,
- "microservicesList": true,
- "microservicesConfig": true,
- "routing": true,
- "registries": true,
- "tunnel": true,
- "diagnostics": true,
- "isImageSnapshot": true,
- "prune": true,
- "routerChanged": true
}
Posts agent status to ioFog node
Authorizations:
Request Body schema: application/jsonrequired
daemonStatus | string |
daemonOperatingDuration | number |
daemonLastStart | number |
memoryUsage | number |
diskUsage | number |
cpuUsage | number |
memoryViolation | boolean |
diskViolation | boolean |
cpuViolation | boolean |
systemAvailableDisk | integer |
systemAvailableMemory | integer |
systemTotalCpu | number |
microserviceStatus | string |
repositoryCount | number |
repositoryStatus | string |
systemTime | number |
lastStatusTime | number |
ipAddress | string |
processedMessages | number |
microserviceMessageCounts | string |
messageSpeed | number |
lastCommandTime | number |
tunnelStatus | string |
version | string |
isReadyToUpgrade | boolean |
isReadyToRollback | boolean |
Responses
Request samples
- Payload
{- "daemonStatus": "string",
- "daemonOperatingDuration": 0,
- "daemonLastStart": 0,
- "memoryUsage": 0,
- "diskUsage": 0,
- "cpuUsage": 0,
- "memoryViolation": true,
- "diskViolation": true,
- "cpuViolation": true,
- "systemAvailableDisk": 0,
- "systemAvailableMemory": 0,
- "systemTotalCpu": 0,
- "microserviceStatus": "string",
- "repositoryCount": 0,
- "repositoryStatus": "string",
- "systemTime": 0,
- "lastStatusTime": 0,
- "ipAddress": "string",
- "processedMessages": 0,
- "microserviceMessageCounts": "string",
- "messageSpeed": 0,
- "lastCommandTime": 0,
- "tunnelStatus": "string",
- "version": "string",
- "isReadyToUpgrade": true,
- "isReadyToRollback": true
}
Response samples
- 200
{- "microservices": [
- {
- "uuid": "string",
- "imageId": "string",
- "config": "string",
- "rebuild": true,
- "rootHostAccess": true,
- "logSize": 0,
- "registryId": 0,
- "portMappings": [
- {
- "portInternal": 80,
- "portExternal": 80
}
], - "volumeMappings": [
- {
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw"
}
], - "imageSnapshot": "string",
- "delete": true,
- "deleteWithCleanUp": true,
- "env": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "idConsumer": true
}
]
}
Gets microservices running on an ioFog node
Authorizations:
path Parameters
microserviceUuid required | string Microservice UUID |
Responses
Response samples
- 200
{- "uuid": "string",
- "imageId": "string",
- "config": "string",
- "rebuild": true,
- "rootHostAccess": true,
- "logSize": 0,
- "registryId": 0,
- "portMappings": [
- {
- "portInternal": 80,
- "portExternal": 80
}
], - "volumeMappings": [
- {
- "hostDestination": "/var/dest",
- "containerDestination": "/var/dest",
- "accessMode": "rw"
}
], - "imageSnapshot": "string",
- "delete": true,
- "deleteWithCleanUp": true,
- "env": [
- {
- "key": "string",
- "value": "string"
}
], - "runAsUser": "string",
- "platform": "string",
- "runtime": "string",
- "cdiDevices": [
- "string"
], - "cmd": [
- "string"
], - "idConsumer": true
}
Response samples
- 200
{- "registries": [
- {
- "id": 0,
- "url": "string",
- "isPublic": true,
- "isSecure": true,
- "certificate": "string",
- "requiresCert": true,
- "username": "string",
- "password": "string",
- "userEmail": "string"
}
]
}
Posts agent strace to ioFog node
Authorizations:
Request Body schema: application/jsonrequired
Array of objects (MicroserviceStraceBuffer) | |||||
Array
|
Responses
Request samples
- Payload
{- "straceData": [
- {
- "microserviceUuid": "string",
- "buffer": "string"
}
]
}
Post tracking info
Authorizations:
Request Body schema: application/jsonrequired
uuid required | string |
sourceType | string |
timestamp | number |
type | string |
data | object |
Responses
Request samples
- Payload
[- {
- "uuid": "string",
- "sourceType": "string",
- "timestamp": 0,
- "type": "string",
- "data": { }
}
]
Login
Request Body schema: application/jsonrequired
email required | string |
password required | string |
totp required | string |
Responses
Request samples
- Payload
{- "email": "string",
- "password": "string",
- "totp": "string"
}
Response samples
- 200
{- "accessToken": "string"
}
Response samples
- 200
{- "userinfo": [
- {
- "sub": "string",
- "SubscriptionKey": "string",
- "email_verified": "string",
- "name": "string",
- "preferred_username": "string",
- "locale": "string",
- "given_name": "string",
- "family_name": "string",
- "email": "string"
}
]
}