API Definition

13KB

Container Manager Schema.yaml

Get all service containers

get

/containers

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/containers'

200

404

200

[
  {}
]

All service containers

Inspect service container

get

/containers/{name}/inspect

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/containers/{name}/inspect'

200

404

200

{}

Service container inspect

Get service container logs

get

/containers/{name}/logs

Path parameters

namestringrequired

Name of the service container

Query parameters

timestampsstring · enum

If the logs should yield timestamp

Options: true, false

tailstring · default: all

Use 'all' to retrieve all, or a number for a limited set

sincestring

Timestamp for the start

untilstring

Timestamp for the end

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/containers/{name}/logs'

200

404

200

text

Service container logs

Get container state

get

/containers/{name}/state

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/containers/{name}/state'

200

404

200

{}

Service container state

Returns info about orchestrator being used to run Connectware

get

/containers/orchestrator

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/containers/orchestrator'

200

200

{
  "orchestrator": "Docker"
}

Returns the name of the orchestrator being used to run Connectware

Perform an operation on a service container

put

/containers/{name}/operation

Path parameters

namestringrequired

Name of the service container

Body

operationstring · enumrequired

Options: start, stop, restart

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/containers/{name}/operation' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"start"}'

200

400

404

200

{}

Service container inspection after operation is performed

Get all core containers

get

/core-containers

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/core-containers'

200

404

200

[
  {}
]

All core containers

Inspect core container

get

/core-containers/{name}/inspect

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/core-containers/{name}/inspect'

200

404

200

{}

Core container inspect

Get core container logs

get

/core-containers/{name}/logs

Path parameters

namestringrequired

Name of the core container

Query parameters

timestampsstring · enum

If the logs should yield timestamp

Options: true, false

tailstring · default: all

Use 'all' to retrieve all, or a number for a limited set

sincestring

Timestamp for the start

untilstring

Timestamp for the end

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/core-containers/{name}/logs'

200

404

200

text

Core container logs

Get core container state

get

/core-containers/{name}/state

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/core-containers/{name}/state'

200

404

200

{}

Core Container state

Returns info about orchestrator being used to run Connectware

get

/core-containers/orchestrator

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/core-containers/orchestrator'

200

200

{
  "orchestrator": "Docker"
}

Returns the name of the orchestrator being used to run Connectware

Perform an operation on a core container

put

/core-containers/{name}/operation

Path parameters

namestringrequired

Name of the core container

Body

operationstring · enumrequired

Options: start, stop, restart

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/core-containers/{name}/operation' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"start"}'

200

400

404

200

{}

Core container inspection after operation is performed

Get all images

get

/images

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/images'

200

404

200

[
  {}
]

All images

Inspect a image

get

/images/{name}/inspect

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/images/{name}/inspect'

200

404

200

{}

Image inspect

Get all networks

get

/networks

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/networks'

200

404

200

[
  {}
]

All networks

Inspect a network

get

/networks/{name}/inspect

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/networks/{name}/inspect'

200

404

200

{}

Network inspect

Get all volumes

get

/volumes

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/volumes'

200

404

200

[
  {}
]

All volumes

Inspect a volume

get

/volumes/{name}/inspect

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/volumes/{name}/inspect'

200

404

200

{}

Volume inspect