API Definition

13KB

Container Manager Schema.yaml

Open

Get all service containers

get

Authorizations

ApiKeyHeader

Responses

200

All service containers

application/json

Responseobject[]

404

Failed to get all service containers

get

/containers

HTTPcURLJavaScriptPython

GET /api/containers HTTP/1.1
Host: 
Accept: */*

[
  {}
]

Inspect service container

get

Authorizations

ApiKeyHeader

Responses

200

Service container inspect

application/json

Responseobject

404

Failed to inspect service container

get

/containers/{name}/inspect

HTTPcURLJavaScriptPython

GET /api/containers/{name}/inspect HTTP/1.1
Host: 
Accept: */*

{}

Get service container logs

get

Authorizations

ApiKeyHeader

Path parameters

namestringRequired

Name of the service container

Query parameters

timestampsstring · enumOptional

If the logs should yield timestamp

Possible values:

tailstringOptional

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

sincestringOptional

Timestamp for the start

untilstringOptional

Timestamp for the end

Responses

200

Service container logs

application/json

Responsestring

404

Failed to get container logs

get

/containers/{name}/logs

HTTPcURLJavaScriptPython

GET /api/containers/{name}/logs HTTP/1.1
Host: 
Accept: */*

text

Get container state

get

Authorizations

ApiKeyHeader

Responses

200

Service container state

application/json

Responseobject

404

Failed to get service container state

get

/containers/{name}/state

HTTPcURLJavaScriptPython

GET /api/containers/{name}/state HTTP/1.1
Host: 
Accept: */*

{}

Returns info about orchestrator being used to run Connectware

get

Responses

200

Returns the name of the orchestrator being used to run Connectware

application/json

get

/containers/orchestrator

HTTPcURLJavaScriptPython

GET /api/containers/orchestrator HTTP/1.1
Host: 
Accept: */*

200

Returns the name of the orchestrator being used to run Connectware

{
  "orchestrator": "Docker"
}

Perform an operation on a service container

put

Authorizations

ApiKeyHeader

Path parameters

namestringRequired

Name of the service container

Body

application/json

operationstring · enumRequiredPossible values:

Responses

200

Service container inspection after operation is performed

application/json

Responseobject

400

Invalid request

404

Service container not found

put

/containers/{name}/operation

HTTPcURLJavaScriptPython

PUT /api/containers/{name}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}

{}

Get all core containers

get

Authorizations

ApiKeyHeader

Responses

200

All core containers

application/json

Responseobject[]

404

Failed to get all core containers

get

/core-containers

HTTPcURLJavaScriptPython

GET /api/core-containers HTTP/1.1
Host: 
Accept: */*

[
  {}
]

Inspect core container

get

Authorizations

ApiKeyHeader

Responses

200

Core container inspect

application/json

Responseobject

404

Failed to inspect core container

get

/core-containers/{name}/inspect

HTTPcURLJavaScriptPython

GET /api/core-containers/{name}/inspect HTTP/1.1
Host: 
Accept: */*

{}

Get core container logs

get

Authorizations

ApiKeyHeader

Path parameters

namestringRequired

Name of the core container

Query parameters

timestampsstring · enumOptional

If the logs should yield timestamp

Possible values:

tailstringOptional

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

sincestringOptional

Timestamp for the start

untilstringOptional

Timestamp for the end

Responses

200

Core container logs

application/json

Responsestring

404

Failed to get core container logs

get

/core-containers/{name}/logs

HTTPcURLJavaScriptPython

GET /api/core-containers/{name}/logs HTTP/1.1
Host: 
Accept: */*

text

Get core container state

get

Authorizations

ApiKeyHeader

Responses

200

Core Container state

application/json

Responseobject

404

Failed to get core container state

get

/core-containers/{name}/state

HTTPcURLJavaScriptPython

GET /api/core-containers/{name}/state HTTP/1.1
Host: 
Accept: */*

{}

Returns info about orchestrator being used to run Connectware

get

Responses

200

Returns the name of the orchestrator being used to run Connectware

application/json

get

/core-containers/orchestrator

HTTPcURLJavaScriptPython

GET /api/core-containers/orchestrator HTTP/1.1
Host: 
Accept: */*

200

Returns the name of the orchestrator being used to run Connectware

{
  "orchestrator": "Docker"
}

Perform an operation on a core container

put

Authorizations

ApiKeyHeader

Path parameters

namestringRequired

Name of the core container

Body

application/json

operationstring · enumRequiredPossible values:

Responses

200

Core container inspection after operation is performed

application/json

Responseobject

400

Invalid request

404

Core container not found

put

/core-containers/{name}/operation

HTTPcURLJavaScriptPython

PUT /api/core-containers/{name}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}

{}

Get all images

get

Authorizations

ApiKeyHeader

Responses

200

All images

application/json

Responseobject[]

404

Failed to get all images

get

/images

HTTPcURLJavaScriptPython

GET /api/images HTTP/1.1
Host: 
Accept: */*

[
  {}
]

Inspect a image

get

Authorizations

ApiKeyHeader

Responses

200

Image inspect

application/json

Responseobject

404

Failed to inspect image

get

/images/{name}/inspect

HTTPcURLJavaScriptPython

GET /api/images/{name}/inspect HTTP/1.1
Host: 
Accept: */*

{}

Get all networks

get

Authorizations

ApiKeyHeader

Responses

200

All networks

application/json

Responseobject[]

404

Failed to get all networks

get

/networks

HTTPcURLJavaScriptPython

GET /api/networks HTTP/1.1
Host: 
Accept: */*

[
  {}
]

Inspect a network

get

Authorizations

ApiKeyHeader

Responses

200

Network inspect

application/json

Responseobject

404

Failed to inspect network

get

/networks/{name}/inspect

HTTPcURLJavaScriptPython

GET /api/networks/{name}/inspect HTTP/1.1
Host: 
Accept: */*

{}

Get all volumes

get

Authorizations

ApiKeyHeader

Responses

200

All volumes

application/json

Responseobject[]

404

Failed to get all volumes

get

/volumes

HTTPcURLJavaScriptPython

GET /api/volumes HTTP/1.1
Host: 
Accept: */*

[
  {}
]

Inspect a volume

get

Authorizations

ApiKeyHeader

Responses

200

Volume inspect

application/json

Responseobject

404

Failed to inspect volume

get

/volumes/{name}/inspect

HTTPcURLJavaScriptPython

GET /api/volumes/{name}/inspect HTTP/1.1
Host: 
Accept: */*

{}