Introduction

Topics

Messages

Schemas

NPG 1.0.0

NPG server API

Topics

Messages

listProjects

List all projects

Payload

Name Title Type Format Default Description
Message Payload

listProjectsResp

Project list

Payload

Name Title Type Format Default Description
Message Payload array (object)
id string uuid
name (Required) string
topology object
backends array (object)
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
nodes array (object)
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
links array (object)
node (Required) object
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
bridge (Required) object
name (Required) string
x integer
y integer
up object
bw integer
delay integer
down object
bw integer
delay integer

Example of payload (generated)

[
  {
    "id": "string",
    "name": "string",
    "topology": {
      "backends": [
        {
          "host": "string",
          "os": "string",
          "cpu": "string",
          "cpu_usage": "string",
          "mem": "string",
          "mem_usage": "string",
          "docker_version": "string",
          "uptime": "string"
        }
      ],
      "nodes": [
        {
          "backend": {
            "host": "string",
            "os": "string",
            "cpu": "string",
            "cpu_usage": "string",
            "mem": "string",
            "mem_usage": "string",
            "docker_version": "string",
            "uptime": "string"
          },
          "name": "string",
          "image": "string",
          "x": 0,
          "y": 0
        }
      ],
      "links": [
        {
          "node": {
            "backend": {
              "host": "string",
              "os": "string",
              "cpu": "string",
              "cpu_usage": "string",
              "mem": "string",
              "mem_usage": "string",
              "docker_version": "string",
              "uptime": "string"
            },
            "name": "string",
            "image": "string",
            "x": 0,
            "y": 0
          },
          "bridge": {
            "name": "string",
            "x": 0,
            "y": 0
          },
          "up": {
            "bw": 0,
            "delay": 0
          },
          "down": {
            "bw": 0,
            "delay": 0
          }
        }
      ]
    }
  }
]

addProject

Add a new project

Payload

Name Title Type Format Default Description
id string uuid
name (Required) string
topology object
backends array (object)
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
nodes array (object)
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
links array (object)
node (Required) object
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
bridge (Required) object
name (Required) string
x integer
y integer
up object
bw integer
delay integer
down object
bw integer
delay integer

Example of payload (generated)

{
  "id": "string",
  "name": "string",
  "topology": {
    "backends": [
      {
        "host": "string",
        "os": "string",
        "cpu": "string",
        "cpu_usage": "string",
        "mem": "string",
        "mem_usage": "string",
        "docker_version": "string",
        "uptime": "string"
      }
    ],
    "nodes": [
      {
        "backend": {
          "host": "string",
          "os": "string",
          "cpu": "string",
          "cpu_usage": "string",
          "mem": "string",
          "mem_usage": "string",
          "docker_version": "string",
          "uptime": "string"
        },
        "name": "string",
        "image": "string",
        "x": 0,
        "y": 0
      }
    ],
    "links": [
      {
        "node": {
          "backend": {
            "host": "string",
            "os": "string",
            "cpu": "string",
            "cpu_usage": "string",
            "mem": "string",
            "mem_usage": "string",
            "docker_version": "string",
            "uptime": "string"
          },
          "name": "string",
          "image": "string",
          "x": 0,
          "y": 0
        },
        "bridge": {
          "name": "string",
          "x": 0,
          "y": 0
        },
        "up": {
          "bw": 0,
          "delay": 0
        },
        "down": {
          "bw": 0,
          "delay": 0
        }
      }
    ]
  }
}

addProjectResp

Result of project addition

Payload

Name Title Type Format Default Description
code (Required) integer
message string

Example of payload (generated)

{
  "code": 0,
  "message": "string"
}

loadProject

Load a project

Payload

Name Title Type Format Default Description
id string uuid

Example of payload (generated)

{
  "id": "string"
}

loadProjectResp

Loaded project information

Payload

Name Title Type Format Default Description
id string uuid
name (Required) string
topology object
backends array (object)
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
nodes array (object)
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
links array (object)
node (Required) object
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
bridge (Required) object
name (Required) string
x integer
y integer
up object
bw integer
delay integer
down object
bw integer
delay integer

Example of payload (generated)

{
  "id": "string",
  "name": "string",
  "topology": {
    "backends": [
      {
        "host": "string",
        "os": "string",
        "cpu": "string",
        "cpu_usage": "string",
        "mem": "string",
        "mem_usage": "string",
        "docker_version": "string",
        "uptime": "string"
      }
    ],
    "nodes": [
      {
        "backend": {
          "host": "string",
          "os": "string",
          "cpu": "string",
          "cpu_usage": "string",
          "mem": "string",
          "mem_usage": "string",
          "docker_version": "string",
          "uptime": "string"
        },
        "name": "string",
        "image": "string",
        "x": 0,
        "y": 0
      }
    ],
    "links": [
      {
        "node": {
          "backend": {
            "host": "string",
            "os": "string",
            "cpu": "string",
            "cpu_usage": "string",
            "mem": "string",
            "mem_usage": "string",
            "docker_version": "string",
            "uptime": "string"
          },
          "name": "string",
          "image": "string",
          "x": 0,
          "y": 0
        },
        "bridge": {
          "name": "string",
          "x": 0,
          "y": 0
        },
        "up": {
          "bw": 0,
          "delay": 0
        },
        "down": {
          "bw": 0,
          "delay": 0
        }
      }
    ]
  }
}

deleteProject

Delete a project

Payload

Name Title Type Format Default Description
id string uuid

Example of payload (generated)

{
  "id": "string"
}

deleteProjectResp

Result of project deletion

Payload

Name Title Type Format Default Description
code (Required) integer
message string

Example of payload (generated)

{
  "code": 0,
  "message": "string"
}

version

Get server version

Payload

Name Title Type Format Default Description
Message Payload

versionResp

Server version

Payload

Name Title Type Format Default Description
Message Payload integer

Example of payload (generated)

""

listBackends

List backend servers

Payload

Name Title Type Format Default Description
Message Payload

listBackendsResp

Backend server list

Payload

Name Title Type Format Default Description
Message Payload array (object)
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string

Example of payload (generated)

[
  {
    "host": "string",
    "os": "string",
    "cpu": "string",
    "cpu_usage": "string",
    "mem": "string",
    "mem_usage": "string",
    "docker_version": "string",
    "uptime": "string"
  }
]

listTerms

List terminal

Payload

Name Title Type Format Default Description
Message Payload

listTermsResp

Terminal list

Payload

Name Title Type Format Default Description
Message Payload array (object)
id (Required) string
backend string
container string
process string

Example of payload (generated)

[
  {
    "id": "string",
    "backend": "string",
    "container": "string",
    "process": "string"
  }
]

addTerm

Add a new terminal

Payload

Name Title Type Format Default Description
cols integer
rows integer
backend string
container string

Example of payload (generated)

{
  "cols": 0,
  "rows": 0,
  "backend": "string",
  "container": "string"
}

addTermResp

Added a new terminal

Payload

Name Title Type Format Default Description
id (Required) string
backend string
container string
process string

Example of payload (generated)

{
  "id": "string",
  "backend": "string",
  "container": "string",
  "process": "string"
}

loadTerm

Load a terminal

Payload

Name Title Type Format Default Description
id string

Example of payload (generated)

{
  "id": "string"
}

loadTermResp

Loaded terminal information

Payload

Name Title Type Format Default Description
id (Required) string
backend string
container string
process string

Example of payload (generated)

{
  "id": "string",
  "backend": "string",
  "container": "string",
  "process": "string"
}

deleteTerm

Delete a terminal

Payload

Name Title Type Format Default Description
id string

Example of payload (generated)

{
  "id": "string"
}

deleteTermResp

Result of terminal deletion

Payload

Name Title Type Format Default Description
code (Required) integer
message string

Example of payload (generated)

{
  "code": 0,
  "message": "string"
}

Schemas

project

Name Title Type Format Default Description
id string uuid
name (Required) string
topology object
backends array (object)
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
nodes array (object)
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
links array (object)
node (Required) object
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
bridge (Required) object
name (Required) string
x integer
y integer
up object
bw integer
delay integer
down object
bw integer
delay integer

Example (generated)

{
  "id": "string",
  "name": "string",
  "topology": {
    "backends": [
      {
        "host": "string",
        "os": "string",
        "cpu": "string",
        "cpu_usage": "string",
        "mem": "string",
        "mem_usage": "string",
        "docker_version": "string",
        "uptime": "string"
      }
    ],
    "nodes": [
      {
        "backend": {
          "host": "string",
          "os": "string",
          "cpu": "string",
          "cpu_usage": "string",
          "mem": "string",
          "mem_usage": "string",
          "docker_version": "string",
          "uptime": "string"
        },
        "name": "string",
        "image": "string",
        "x": 0,
        "y": 0
      }
    ],
    "links": [
      {
        "node": {
          "backend": {
            "host": "string",
            "os": "string",
            "cpu": "string",
            "cpu_usage": "string",
            "mem": "string",
            "mem_usage": "string",
            "docker_version": "string",
            "uptime": "string"
          },
          "name": "string",
          "image": "string",
          "x": 0,
          "y": 0
        },
        "bridge": {
          "name": "string",
          "x": 0,
          "y": 0
        },
        "up": {
          "bw": 0,
          "delay": 0
        },
        "down": {
          "bw": 0,
          "delay": 0
        }
      }
    ]
  }
}

termreq

Name Title Type Format Default Description
cols integer
rows integer
backend string
container string

Example (generated)

{
  "cols": 0,
  "rows": 0,
  "backend": "string",
  "container": "string"
}

term

Name Title Type Format Default Description
id (Required) string
backend string
container string
process string

Example (generated)

{
  "id": "string",
  "backend": "string",
  "container": "string",
  "process": "string"
}

backend

Name Title Type Format Default Description
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string

Example (generated)

{
  "host": "string",
  "os": "string",
  "cpu": "string",
  "cpu_usage": "string",
  "mem": "string",
  "mem_usage": "string",
  "docker_version": "string",
  "uptime": "string"
}

node

Name Title Type Format Default Description
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer

Example (generated)

{
  "backend": {
    "host": "string",
    "os": "string",
    "cpu": "string",
    "cpu_usage": "string",
    "mem": "string",
    "mem_usage": "string",
    "docker_version": "string",
    "uptime": "string"
  },
  "name": "string",
  "image": "string",
  "x": 0,
  "y": 0
}

bridge

Name Title Type Format Default Description
name (Required) string
x integer
y integer

Example (generated)

{
  "name": "string",
  "x": 0,
  "y": 0
}

netem

Name Title Type Format Default Description
bw integer
delay integer

Example (generated)

{
  "bw": 0,
  "delay": 0
}

link

Name Title Type Format Default Description
node (Required) object
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
bridge (Required) object
name (Required) string
x integer
y integer
up object
bw integer
delay integer
down object
bw integer
delay integer

Example (generated)

{
  "node": {
    "backend": {
      "host": "string",
      "os": "string",
      "cpu": "string",
      "cpu_usage": "string",
      "mem": "string",
      "mem_usage": "string",
      "docker_version": "string",
      "uptime": "string"
    },
    "name": "string",
    "image": "string",
    "x": 0,
    "y": 0
  },
  "bridge": {
    "name": "string",
    "x": 0,
    "y": 0
  },
  "up": {
    "bw": 0,
    "delay": 0
  },
  "down": {
    "bw": 0,
    "delay": 0
  }
}

topology

Name Title Type Format Default Description
backends array (object)
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
nodes array (object)
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
links array (object)
node (Required) object
backend (Required) object
host (Required) string
os string
cpu string CPU type and number of cores
cpu_usage string CPU usage in percent
mem string total memory in MB
mem_usage string memory usage in percent
docker_version string
uptime string
name (Required) string
image (Required) string
x integer
y integer
bridge (Required) object
name (Required) string
x integer
y integer
up object
bw integer
delay integer
down object
bw integer
delay integer

Example (generated)

{
  "backends": [
    {
      "host": "string",
      "os": "string",
      "cpu": "string",
      "cpu_usage": "string",
      "mem": "string",
      "mem_usage": "string",
      "docker_version": "string",
      "uptime": "string"
    }
  ],
  "nodes": [
    {
      "backend": {
        "host": "string",
        "os": "string",
        "cpu": "string",
        "cpu_usage": "string",
        "mem": "string",
        "mem_usage": "string",
        "docker_version": "string",
        "uptime": "string"
      },
      "name": "string",
      "image": "string",
      "x": 0,
      "y": 0
    }
  ],
  "links": [
    {
      "node": {
        "backend": {
          "host": "string",
          "os": "string",
          "cpu": "string",
          "cpu_usage": "string",
          "mem": "string",
          "mem_usage": "string",
          "docker_version": "string",
          "uptime": "string"
        },
        "name": "string",
        "image": "string",
        "x": 0,
        "y": 0
      },
      "bridge": {
        "name": "string",
        "x": 0,
        "y": 0
      },
      "up": {
        "bw": 0,
        "delay": 0
      },
      "down": {
        "bw": 0,
        "delay": 0
      }
    }
  ]
}

result

Name Title Type Format Default Description
code (Required) integer
message string

Example (generated)

{
  "code": 0,
  "message": "string"
}