API Definition

13KB

Container Manager Schema.yaml

Get all service containers

GET/api/containers

Response

200404

All service containers

Body

application/json

array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/containers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]

Inspect service container

GET/api/containers/{name}/inspect

Response

200404

Service container inspect

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/containers/{name}/inspect', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get service container logs

GET/api/containers/{name}/logs

Path parameters

name*string

Name of the service container

Query parameters

Response

200404

Service container logs

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/containers/{name}/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Get container state

GET/api/containers/{name}/state

Response

200404

Service container state

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/containers/{name}/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Returns info about orchestrator being used to run Connectware

GET/api/containers/orchestrator

Response

200

Returns the name of the orchestrator being used to run Connectware

Body

application/json

orchestratorenum

DockerKubernetes

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/containers/orchestrator', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "orchestrator": "Docker"
}

Perform an operation on a service container

PUT/api/containers/{name}/operation

Path parameters

name*string

Name of the service container

Body

application/json

Operation to perform on the service container

operation*enum

startstoprestart

Response

200400404

Service container inspection after operation is performed

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/containers/{name}/operation', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "start"
    }),
});
const data = await response.json();

Get all core containers

GET/api/core-containers

Response

200404

All core containers

Body

application/json

array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/core-containers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]

Inspect core container

GET/api/core-containers/{name}/inspect

Response

200404

Core container inspect

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/core-containers/{name}/inspect', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get core container logs

GET/api/core-containers/{name}/logs

Path parameters

name*string

Name of the core container

Query parameters

Response

200404

Core container logs

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/core-containers/{name}/logs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Get core container state

GET/api/core-containers/{name}/state

Response

200404

Core Container state

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/core-containers/{name}/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Returns info about orchestrator being used to run Connectware

GET/api/core-containers/orchestrator

Response

200

Returns the name of the orchestrator being used to run Connectware

Body

application/json

orchestratorenum

DockerKubernetes

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/core-containers/orchestrator', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "orchestrator": "Docker"
}

Perform an operation on a core container

PUT/api/core-containers/{name}/operation

Path parameters

name*string

Name of the core container

Body

application/json

Operation to perform on the core container

operation*enum

startstoprestart

Response

200400404

Core container inspection after operation is performed

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/core-containers/{name}/operation', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "start"
    }),
});
const data = await response.json();

Get all images

GET/api/images

Response

200404

All images

Body

application/json

array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/images', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]

Inspect a image

GET/api/images/{name}/inspect

Response

200404

Image inspect

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/images/{name}/inspect', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get all networks

GET/api/networks

Response

200404

All networks

Body

application/json

array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/networks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]

Inspect a network

GET/api/networks/{name}/inspect

Response

200404

Network inspect

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/networks/{name}/inspect', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get all volumes

GET/api/volumes

Response

200404

All volumes

Body

application/json

array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/volumes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]

Inspect a volume

GET/api/volumes/{name}/inspect

Response

200404

Volume inspect

Body

application/json

object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/api/volumes/{name}/inspect', {
    method: 'GET',
    headers: {},
});
const data = await response.json();