Skip to main content
API docs by Redocly

Datasance PoT Controller (3.5.10)

Download OpenAPI specification:Download

Controller

Manage your controller

Returns service health status

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "timestamp": 0
}

Gets ioFog types list

Responses

Response samples

Content type
application/json
{
  • "fogTypes": [
    ]
}

ioFog

Manage your agents

Returns list of ioFog nodes

Authorizations:
authToken
Request Body schema: application/json
Array
key
string
value
string
condition
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "fogs": [
    ]
}

Creates a new ioFog node

Authorizations:
authToken
Request Body schema: application/json
required
name
string
location
string
latitude
number
longitude
number
description
string
dockerUrl
string
Default: "unix:///var/run/docker.sock"
containerEngine
string
Default: "docker"
deploymentType
string
Default: "native"
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

Content type
application/json
{
  • "name": "string",
  • "location": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "description": "string",
  • "dockerUrl": "unix:///var/run/docker.sock",
  • "containerEngine": "docker",
  • "deploymentType": "native",
  • "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": [
    ],
  • "upstreamRouters": [
    ],
  • "networkRouter": "string"
}

Response samples

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

Updates existing ioFog node

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Request Body schema: application/json
required
name
string
location
string
latitude
number
longitude
number
description
string
dockerUrl
string
Default: "unix:///var/run/docker.sock"
containerEngine
string
Default: "docker"
deploymentType
string
Default: "native"
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

Content type
application/json
{
  • "name": "string",
  • "location": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "description": "string",
  • "dockerUrl": "unix:///var/run/docker.sock",
  • "containerEngine": "docker",
  • "deploymentType": "native",
  • "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": [
    ],
  • "upstreamRouters": [
    ],
  • "networkRouter": "string"
}

Deletes an ioFog node

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

Gets ioFog node info

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

Response samples

Content type
application/json
{
  • "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",
  • "containerEngine": "string",
  • "deploymentType": "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": [
    ]
}

Generates provisioning key for an ioFog node

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "expirationTime": 0
}

Set change version command

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

versionCommand
required
string
Enum: "upgrade" "rollback"

change version command

Responses

remote reboot fog agent

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

prune remote fog agent

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

Retrieves HAL hardware info

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

Response samples

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

Retrieves HAL USB info

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

Response samples

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

Retrieves HAL USB info

Authorizations:
authToken

Responses

Response samples

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

Application

Manage your applications

Lists all applications

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ]
}

Lists all system applications

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ]
}

Gets an application details

Authorizations:
authToken
path Parameters
name
required
string

Application name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "isActivated": true,
  • "microservices": [
    ],
  • "routes": [
    ]
}

Deletes a system application

Authorizations:
authToken
path Parameters
name
required
string

Application name

Responses

Creates an application using a YAML file

Authorizations:
authToken
Request Body schema: multipart/form-data
required
application
string <binary>

Responses

Response samples

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

Updates an application metadata

Authorizations:
authToken
path Parameters
name
required
string

Application name

Request Body schema: application/json
required
name
string
description
string
isActivated
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isActivated": true
}

Deletes an application

Authorizations:
authToken
path Parameters
name
required
string

Application name

Responses

Gets an application details

Authorizations:
authToken
path Parameters
name
required
string

Application name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "isActivated": true,
  • "microservices": [
    ],
  • "routes": [
    ]
}

Updates an application using a YAML file

Authorizations:
authToken
path Parameters
name
required
string

Application name

Request Body schema: multipart/form-data
required
application
string <binary>

Responses

Application Template

Manage your application templates

Lists all application templates

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "applicationTemplates": [
    ]
}

Creates an application template using a YAML file

Authorizations:
authToken
Request Body schema: multipart/form-data
required
application
string <binary>

Responses

Response samples

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

Patches an application template

Authorizations:
authToken
path Parameters
name
required
string

Application template name

Request Body schema: application/json
required
description
number
name
string

Responses

Request samples

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

Deletes an application template

Authorizations:
authToken
path Parameters
name
required
string

Application template name

Responses

Gets an application template

Authorizations:
authToken
path Parameters
name
required
string

Application template name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "application": {
    }
}

Updates or creates an application template

Authorizations:
authToken
path Parameters
name
required
string

Application template name

Request Body schema: multipart/form-data
required
template
string <binary>

Responses

Response samples

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

Catalog

Manage your catalog

Gets microservices catalog

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "catalogItems": [
    ]
}

Creates a new microservice catalog item

Authorizations:
authToken
Request Body schema: application/json
required

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

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "images": [
    ],
  • "publisher": "string",
  • "diskRequired": 0,
  • "ramRequired": 0,
  • "picture": "string",
  • "isPublic": true,
  • "registryId": 0,
  • "inputType": {
    },
  • "outputType": {
    },
  • "configExample": "string"
}

Response samples

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

Gets microservice catalog item info

Authorizations:
authToken
path Parameters
id
required
string

Catalog Item Id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "publisher": "string",
  • "diskRequired": 0,
  • "ramRequired": 0,
  • "picture": "string",
  • "isPublic": true,
  • "registryId": 0,
  • "inputType": {
    },
  • "outputType": {
    },
  • "configExample": "string",
  • "images": [
    ]
}

Updates a microservice catalog item

Authorizations:
authToken
path Parameters
id
required
string

Catalog Item Id

Request Body schema: application/json
required

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

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "string",
  • "images": [
    ],
  • "publisher": "string",
  • "diskRequired": 0,
  • "ramRequired": 0,
  • "picture": "string",
  • "isPublic": true,
  • "registryId": 0,
  • "inputType": {
    },
  • "outputType": {
    },
  • "configExample": "string"
}

Deletes a microservice catalog item

Authorizations:
authToken
path Parameters
id
required
string

Catalog Item Id

Responses

Registries

Manage your registries

Creates new registry

Authorizations:
authToken
Request Body schema: application/json
url
string
isPublic
boolean
username
string
password
string
email
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "isPublic": true,
  • "username": "string",
  • "password": "string",
  • "email": "string"
}

Gets list of registries

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "registries": [
    ]
}

Deletes a registry

Authorizations:
authToken
path Parameters
id
required
string

Registry id

Responses

Updates a registry

Authorizations:
authToken
path Parameters
id
required
string

Registry id

Request Body schema: application/json
required
url
string
isPublic
boolean
username
string
password
string
email
string

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "isPublic": true,
  • "username": "string",
  • "password": "string",
  • "email": "string"
}

Microservices

Manage your microservices

Gets list of microservices

Authorizations:
authToken
query Parameters
flowId
integer
Deprecated

Flow Id

application
string

Application name

Responses

Response samples

Content type
application/json
{
  • "microservices": [
    ]
}

Creates a new microservice in an Application

Authorizations:
authToken
Request Body schema: multipart/form-data
required
microsoervice
string <binary>

Responses

Response samples

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

Gets a microservice info

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "config": "string",
  • "annotations": "string",
  • "hostNetworkMode": true,
  • "isPrivileged": true,
  • "logLimit": 0,
  • "images": [
    ],
  • "iofogUuid": "string",
  • "envs": [
    ],
  • "runAsUser": "string",
  • "platform": "string",
  • "runtime": "string",
  • "cdiDevices": [
    ],
  • "capAdd": [
    ],
  • "capDrop": [
    ],
  • "cmd": [
    ],
  • "volumeMappings": [
    ],
  • "ports": [
    ],
  • "status": {
    }
}

Deletes a microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Updates a microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Get list of microservices with filtered pub tag

Authorizations:
authToken
path Parameters
tag
required
string

Microservice Pub Tags

Responses

Response samples

Content type
application/json
{
  • "microservices": [
    ]
}

Get list of microservices with filtered sub tag

Authorizations:
authToken
path Parameters
tag
required
string

Microservice Pub Tags

Responses

Response samples

Content type
application/json
{
  • "microservices": [
    ]
}

Gets list of system microservices

Authorizations:
authToken
query Parameters
flowId
integer
Deprecated

Flow Id

application
string

Application name

Responses

Response samples

Content type
application/json
{
  • "microservices": [
    ]
}

Gets a system microservice info

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "config": "string",
  • "annotations": "string",
  • "hostNetworkMode": true,
  • "isPrivileged": true,
  • "logLimit": 0,
  • "images": [
    ],
  • "iofogUuid": "string",
  • "envs": [
    ],
  • "runAsUser": "string",
  • "platform": "string",
  • "runtime": "string",
  • "cdiDevices": [
    ],
  • "capAdd": [
    ],
  • "capDrop": [
    ],
  • "cmd": [
    ],
  • "volumeMappings": [
    ],
  • "ports": [
    ],
  • "status": {
    }
}

Updates a system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Updates a microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Request Body schema: multipart/form-data
required
microservice
string <binary>

Responses

Gets a microservice config

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Response samples

Content type
application/json
"string"

Updates a microservice config

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Request Body schema: application/json
required

information about microservice config

string (microservicesConfig)

Responses

Request samples

Content type
application/json
"string"

Deletes a microservice config

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Gets a system microservice config

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Response samples

Content type
application/json
"string"

Updates a system microservice config

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Request Body schema: application/json
required

information about microservice config

string (microservicesConfig)

Responses

Request samples

Content type
application/json
"string"

Deletes a system microservice config

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Creates a port mapping for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Request Body schema: application/json
required

information about port mapping

internal
required
number
external
required
number
protocol
string
Enum: "tcp" "udp"

Responses

Request samples

Content type
application/json
{
  • "internal": 0,
  • "external": 0,
  • "protocol": "tcp"
}

Response samples

Content type
application/json
{
  • "internal": 0,
  • "external": 0,
  • "protocol": "tcp"
}

Get a port mapping list for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Response samples

Content type
application/json
{
  • "ports": [
    ]
}

Creates a port mapping for system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Request Body schema: application/json
required

information about port mapping

internal
required
number
external
required
number
protocol
string
Enum: "tcp" "udp"

Responses

Request samples

Content type
application/json
{
  • "internal": 0,
  • "external": 0,
  • "protocol": "tcp"
}

Response samples

Content type
application/json
{
  • "internal": 0,
  • "external": 0,
  • "protocol": "tcp"
}

Deletes a port mapping for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

internalPort
required
string

Internal Port

Responses

Deletes a port mapping for system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

internalPort
required
string

Internal Port

Responses

Creates a volume mapping for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Request Body schema: application/json
required

information about volume mapping

hostDestination
string
containerDestination
string
accessMode
string

Responses

Request samples

Content type
application/json
{
  • "hostDestination": "/var/dest",
  • "containerDestination": "/var/dest",
  • "accessMode": "rw"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Get a volume mapping list for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Response samples

Content type
application/json
{
  • "volumeMappings": [
    ]
}

Creates a volume mapping for system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Request Body schema: application/json
required

information about volume mapping

hostDestination
string
containerDestination
string
accessMode
string

Responses

Request samples

Content type
application/json
{
  • "hostDestination": "/var/dest",
  • "containerDestination": "/var/dest",
  • "accessMode": "rw"
}

Response samples

Content type
application/json
{
  • "id": 0
}

Deletes a volume mapping for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

id
required
string

Volume id

Responses

Deletes a volume mapping for system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

id
required
string

Volume id

Responses

Rebuilds a system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Rebuilds a microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Starts a microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Stops a microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice Uuid

Responses

Enables a exec for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Responses

Disables a exec for microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Responses

Enables a exec for system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Responses

Disables a exec for system microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Responses

Routing

Manage your routes

Get routes

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "routes": [
    ]
}

Creates a new route

Authorizations:
authToken
Request Body schema: application/json
required

Route Info

name
required
string
sourceMicroserviceUuid
required
string
destMicroserviceUuid
required
string

Responses

Request samples

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

Response samples

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

Gets a route info

Authorizations:
authToken
path Parameters
name
required
string

Route name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "sourceMicroserviceUuid": "string",
  • "destMicroserviceUuid": "string"
}

Updates a route

Authorizations:
authToken
path Parameters
name
required
string

Route name

Request Body schema: application/json
required

Route Info

name
string
sourceMicroserviceUuid
string
destMicroserviceUuid
string

Responses

Request samples

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

Deletes a route

Authorizations:
authToken
path Parameters
name
required
string

Route name

Responses

Edge Resource

Manage your Edge Resources

Get Edge Resources

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "edgeResources": [
    ]
}

Get Specific Edge Resource

Authorizations:
authToken
path Parameters
name
required
string

Edge Resource name

version
required
string

Edge Resource version

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "interfaceProtocol": "string",
  • "display": {
    },
  • "interface": {
    },
  • "custom": { }
}

Update/Create Specific Edge Resource

Authorizations:
authToken
path Parameters
name
required
string

Edge Resource name

version
required
string

Edge Resource version

Request Body schema: application/json
required

Updated profile data

name
string
description
string
version
string
interfaceProtocol
string
object (EdgeResourceDisplay)
object (EdgeResourceHTTPInterface)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "interfaceProtocol": "string",
  • "display": {
    },
  • "interface": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "interfaceProtocol": "string",
  • "display": {
    },
  • "interface": {
    },
  • "custom": { }
}

Deletes an Edge Resource

Authorizations:
authToken
path Parameters
name
required
string

Edge Resource name

version
required
string

Edge Resource version

Responses

Get Specific Edge Resource versions

Authorizations:
authToken
path Parameters
name
required
string

Edge Resource name

Responses

Response samples

Content type
application/json
{
  • "edgeResources": [
    ]
}

Create Specific Edge Resource

Authorizations:
authToken
Request Body schema: application/json
required

Updated profile data

name
string
description
string
version
string
interfaceProtocol
string
object (EdgeResourceDisplay)
object (EdgeResourceHTTPInterface)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "interfaceProtocol": "string",
  • "display": {
    },
  • "interface": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "interfaceProtocol": "string",
  • "display": {
    },
  • "interface": {
    },
  • "custom": { }
}

Diagnostics

Diagnostic your microservices

Send request to create image snapshot

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Responses

Response samples

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

Download image snapshot

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Responses

Enables Microservice Strace Option

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Request Body schema: application/json
required

Strace info to enable or disable feature

enable
boolean

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Gets Strace Data for Microservice

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

query Parameters
format
required
string
Enum: "file" "string"

Responses

Response samples

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

Posts Microservice Strace file to FTP

Authorizations:
authToken
path Parameters
uuid
required
string

Microservice UUID

Request Body schema: application/json
required
ftpHost
string
ftpPort
number
ftpUser
string
ftpPass
string
ftpDestDir
string

Responses

Request samples

Content type
application/json
{
  • "ftpHost": "string",
  • "ftpPort": 0,
  • "ftpUser": "string",
  • "ftpPass": "string",
  • "ftpDestDir": "string"
}

Tunnel

Manage ssh tunnels

Opens/closes ssh tunnel

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Request Body schema: application/json
required
action
string
Enum: "open" "close"

Responses

Request samples

Content type
application/json
{
  • "action": "open"
}

Gets current info about ioFog node ssh tunnel status

Authorizations:
authToken
path Parameters
uuid
required
string

ioFog node id

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "host": "string",
  • "remotePort": 0,
  • "localPort": 0,
  • "status": "string"
}

Agent

Used by your agents to communicate with your controller

Provision agent with an ioFog node

Request Body schema: application/json
required
type
required
number
Enum: 1 2

Architecture

  • '1': x86
  • '2': arm
key
required
string

provisioning key

Responses

Request samples

Content type
application/json
{
  • "type": 1,
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "token": "string"
}

Deprovision agent

Request Body schema: application/json
required
microserviceUuids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "microserviceUuids": [
    ]
}

Move Controller CA to Agent

Authorizations:
authToken

Responses

Get an ioFog node configuration

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "networkInterface": "string",
  • "dockerUrl": "string",
  • "containerEngine": "string",
  • "deploymentType": "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:
authToken
Request Body schema: application/json
required
networkInterface
string
dockerUrl
string
containerEngine
string
deploymentType
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

Content type
application/json
{
  • "networkInterface": "string",
  • "dockerUrl": "string",
  • "containerEngine": "string",
  • "deploymentType": "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
}

Updates an ioFog node GPS configuration

Authorizations:
authToken
Request Body schema: application/json
required
latitude
number
longitude
number

Responses

Request samples

Content type
application/json
{
  • "latitude": 0,
  • "longitude": 0
}

Gets ioFog node changes

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "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
}

Resets ioFog node changes list

Authorizations:
authToken

Responses

Posts agent status to ioFog node

Authorizations:
authToken
Request Body schema: application/json
required
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

Content type
application/json
{
  • "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
}

Gets microservices running on an ioFog node

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "microservices": [
    ]
}

Gets microservices running on an ioFog node

Authorizations:
authToken
path Parameters
microserviceUuid
required
string

Microservice UUID

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "imageId": "string",
  • "config": "string",
  • "annotations": "string",
  • "rebuild": true,
  • "hostNetworkMode": true,
  • "isPrivileged": true,
  • "logSize": 0,
  • "registryId": 0,
  • "portMappings": [
    ],
  • "volumeMappings": [
    ],
  • "imageSnapshot": "string",
  • "delete": true,
  • "deleteWithCleanUp": true,
  • "env": [
    ],
  • "runAsUser": "string",
  • "platform": "string",
  • "runtime": "string",
  • "cdiDevices": [
    ],
  • "capAdd": [
    ],
  • "capDrop": [
    ],
  • "cmd": [
    ],
  • "idConsumer": true
}

Gets list of Docker registries

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "registries": [
    ]
}

Get an ioFog node tunnel configuration

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "host": "string",
  • "remotePort": 0,
  • "localPort": 0,
  • "rsaKey": "string",
  • "closed": true
}

Get an ioFog node strace info

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "straceValues": [
    ]
}

Posts agent strace to ioFog node

Authorizations:
authToken
Request Body schema: application/json
required
Array of objects (MicroserviceStraceBuffer)
Array
microserviceUuid
string
buffer
string

Responses

Request samples

Content type
application/json
{
  • "straceData": [
    ]
}

Get change version command

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "versionCommand": "string",
  • "provisionKey": "string",
  • "expirationTime": "string"
}

Updates HAL hardware info

Authorizations:
authToken
Request Body schema: application/json
required
info
required
string

Responses

Request samples

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

Updates HAL USB info

Authorizations:
authToken
Request Body schema: application/json
required
info
required
string

Responses

Request samples

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

Deletes an ioFog node

Authorizations:
authToken

Responses

Get image snapshot info

Authorizations:
authToken

Responses

Response samples

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

Put image snapshot info on controller

Authorizations:
authToken
Request Body schema: application/json
required
upstream
required
string

Responses

Request samples

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

Post tracking info

Authorizations:
authToken
Request Body schema: application/json
required
Array
uuid
required
string
sourceType
string
timestamp
number
type
string
data
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

User

Manage your users

Login

Request Body schema: application/json
required
object (LoginRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string"
}

Refresh accessToken with refreshToken

Request Body schema: application/json
required
string (RefreshRequest)

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string"
}

Logout

Authorizations:
authToken

Responses

Get current user profile data

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "userinfo": [
    ]
}

Secrets

Manage your secrets

Creates a new secret

Authorizations:
authToken
Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
type
required
string
Enum: "Opaque" "tls"
data
required
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "Opaque",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Lists all secrets

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "secrets": [
    ]
}

Gets a secret by name

Authorizations:
authToken
path Parameters
name
required
string

Secret name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "Opaque",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Updates an existing secret

Authorizations:
authToken
path Parameters
name
required
string

Secret name

Request Body schema: application/json
required
data
required
object

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "Opaque",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Deletes a secret

Authorizations:
authToken
path Parameters
name
required
string

Secret name

Responses

Create a secret from YAML file

Authorizations:
authToken
Request Body schema: multipart/form-data
secret
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "Opaque",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Updates an existing secret using YAML

Authorizations:
authToken
path Parameters
name
required
string

Secret name

Request Body schema: multipart/form-data
secret
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "Opaque",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Certificates

Manage your certificates

Get a Certificate Authority (CA) by name

Authorizations:
authToken
path Parameters
name
required
string

CA name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "subject": "string",
  • "is_ca": true,
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z",
  • "serial_number": "string",
  • "data": {
    }
}

Delete a Certificate Authority (CA) by name

Authorizations:
authToken
path Parameters
name
required
string

CA name

Responses

Create a new certificate

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

Name of the certificate

subject
required
string

Subject of the certificate (CN)

hosts
required
string

Comma-separated list of hosts

expiration
integer

Expiration time in milliseconds

object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subject": "string",
  • "hosts": "string",
  • "expiration": 0,
  • "ca": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "subject": "string",
  • "hosts": "string",
  • "is_ca": true,
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z",
  • "serial_number": "string",
  • "ca_name": "string",
  • "certificate_chain": [
    ],
  • "days_remaining": 0,
  • "is_expired": true,
  • "data": {
    }
}

List all certificates

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "certificates": [
    ]
}

List certificates that will expire soon

Authorizations:
authToken
query Parameters
days
integer
Default: 30

Number of days ahead to check for expiration (default 30)

Responses

Response samples

Content type
application/json
{
  • "certificates": [
    ]
}

Get a certificate by name

Authorizations:
authToken
path Parameters
name
required
string

Certificate name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "subject": "string",
  • "hosts": "string",
  • "is_ca": true,
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z",
  • "serial_number": "string",
  • "ca_name": "string",
  • "certificate_chain": [
    ],
  • "days_remaining": 0,
  • "is_expired": true,
  • "data": {
    }
}

Delete a certificate by name

Authorizations:
authToken
path Parameters
name
required
string

Certificate name

Responses

Renew a certificate

Authorizations:
authToken
path Parameters
name
required
string

Certificate name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "subject": "string",
  • "hosts": "string",
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z",
  • "renewed": true
}

Create a certificate or CA from YAML file

Authorizations:
authToken
Request Body schema: multipart/form-data
certificate
string <binary>

Responses

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "subject": "string",
  • "is_ca": true,
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z",
  • "serial_number": "string",
  • "data": {
    }
}

Services

Manage your services

Gets list of services

Authorizations:
authToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new service

Authorizations:
authToken
Request Body schema: application/json
required
name
string
type
string
resource
string
defaultBridge
string
bridgePort
number
targetPort
number
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "resource": "string",
  • "defaultBridge": "string",
  • "bridgePort": 0,
  • "targetPort": 0,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "resource": "string",
  • "defaultBridge": "string",
  • "bridgePort": 0,
  • "targetPort": 0,
  • "tags": [
    ]
}

Gets a service info

Authorizations:
authToken
path Parameters
name
required
string

Service name

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "resource": "string",
  • "defaultBridge": "string",
  • "bridgePort": 0,
  • "targetPort": 0,
  • "tags": [
    ]
}

Deletes a service

Authorizations:
authToken
path Parameters
name
required
string

Service name

Responses

Patches a service

Authorizations:
authToken
path Parameters
name
required
string

Service name

Request Body schema: application/json
required
name
string
type
string
resource
string
defaultBridge
string
bridgePort
number
targetPort
number
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "resource": "string",
  • "defaultBridge": "string",
  • "bridgePort": 0,
  • "targetPort": 0,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "resource": "string",
  • "defaultBridge": "string",
  • "bridgePort": 0,
  • "targetPort": 0,
  • "tags": [
    ]
}

Creates a new service from YAML

Authorizations:
authToken
Request Body schema: multipart/form-data
required
service
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "type": "string",
  • "resource": "string",
  • "targetPort": 0,
  • "defaultBridge": "string",
  • "bridgePort": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Updates a service using YAML

Authorizations:
authToken
path Parameters
name
required
string

Service name

Request Body schema: multipart/form-data
required
service
string <binary>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "resource": "string",
  • "defaultBridge": "string",
  • "bridgePort": 0,
  • "targetPort": 0,
  • "tags": [
    ]
}

VolumeMounts

Manage your volume mounts

Returns list of volume mounts

Authorizations:
authToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new volume mount

Authorizations:
authToken
Request Body schema: application/json
required
One of
name
required
string
secretName
required
string
configMapName
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "secretName": "string",
  • "configMapName": "string",
  • "version": 0
}

Creates a new volume mount from YAML

Authorizations:
authToken
Request Body schema: application/x-yaml
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "secretName": "string",
  • "configMapName": "string",
  • "version": 0
}

Gets volume mount info

Authorizations:
authToken
path Parameters
name
required
string

Volume mount name

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "secretName": "string",
  • "configMapName": "string",
  • "version": 0
}

Updates existing volume mount

Authorizations:
authToken
path Parameters
name
required
string

Volume mount name

Request Body schema: application/json
required
One of
name
string
secretName
required
string
configMapName
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "secretName": "string",
  • "configMapName": "string",
  • "version": 0
}

Deletes a volume mount

Authorizations:
authToken
path Parameters
name
required
string

Volume mount name

Responses

Updates existing volume mount from YAML

Authorizations:
authToken
path Parameters
name
required
string

Volume mount name

Request Body schema: application/x-yaml
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "secretName": "string",
  • "configMapName": "string",
  • "version": 0
}

Links volume mount to fog nodes

Authorizations:
authToken
path Parameters
name
required
string

Volume mount name

Request Body schema: application/json
required
fogUuids
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "fogUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "secretName": "string",
  • "configMapName": "string",
  • "version": 0
}

Unlinks volume mount from fog nodes

Authorizations:
authToken
path Parameters
name
required
string

Volume mount name

Request Body schema: application/json
required
fogUuids
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "fogUuids": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "secretName": "string",
  • "configMapName": "string",
  • "version": 0
}

ConfigMap

Manage your config maps

Creates a new ConfigMap

Authorizations:
authToken
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters
data
required
object

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Lists all ConfigMaps

Authorizations:
authToken

Responses

Response samples

Content type
application/json
{
  • "configMaps": [
    ]
}

Creates a new ConfigMap from YAML

Authorizations:
authToken
Request Body schema: multipart/form-data
configMap
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Gets a ConfigMap by name

Authorizations:
authToken
path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Updates a ConfigMap

Authorizations:
authToken
path Parameters
name
required
string
Request Body schema: application/json
data
required
object

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Deletes a ConfigMap

Authorizations:
authToken
path Parameters
name
required
string

Responses

Updates a ConfigMap from YAML

Authorizations:
authToken
path Parameters
name
required
string
Request Body schema: multipart/form-data
configMap
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "data": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Events

Manage audit events

List audit events

Retrieve audit events with optional filters and pagination.

Authorizations:
authToken
query Parameters
limit
integer [ 1 .. 1000 ]

Maximum number of events to return (default 200, max 1000)

offset
integer >= 0

Number of events to skip before collecting results

startTime
string

Start of time range (Unix timestamp in ms or ISO 8601)

endTime
string

End of time range (Unix timestamp in ms or ISO 8601)

endpointType
string

Filter by endpoint type (agent or user)

resourceType
string

Filter by resource type (agent, microservice, etc.)

status
string

Filter by status (SUCCESS or FAILED)

method
Array of strings

Filter by HTTP/WS method(s)

actorId
string

Filter by actor identifier (username or fog UUID)

eventType
string

Filter by event type (HTTP, WS_CONNECT, WS_DISCONNECT)

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "total": 0,
  • "limit": 0,
  • "offset": 0
}

Delete audit events

Delete all events when days is 0, or delete events older than the provided number of days.

Authorizations:
authToken
Request Body schema: application/json
required
days
required
integer [ 0 .. 365 ]

Responses

Request samples

Content type
application/json
{
  • "days": 365
}

Response samples

Content type
application/json
{
  • "deletedCount": 0,
  • "deletedBefore": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "deletedAll": true
}