Resources (API)

Get all service containers

get

/containers

Responses
curl -L \
  --url '/api/containers'
[
  {}
]

Inspect service container

get

/containers/{name}/inspect

Responses
curl -L \
  --url '/api/containers/{name}/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
curl -L \
  --url '/api/containers/{name}/logs'
text

Get container state

get

/containers/{name}/state

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

Returns info about orchestrator being used to run Connectware

get

/containers/orchestrator

Responses
curl -L \
  --url '/api/containers/orchestrator'
{
  "orchestrator": "Docker"
}

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
curl -L \
  --request PUT \
  --url '/api/containers/{name}/operation' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"start"}'
{}

Get all core containers

get

/core-containers

Responses
curl -L \
  --url '/api/core-containers'
[
  {}
]

Inspect core container

get

/core-containers/{name}/inspect

Responses
curl -L \
  --url '/api/core-containers/{name}/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
curl -L \
  --url '/api/core-containers/{name}/logs'
text

Get core container state

get

/core-containers/{name}/state

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

Returns info about orchestrator being used to run Connectware

get

/core-containers/orchestrator

Responses
curl -L \
  --url '/api/core-containers/orchestrator'
{
  "orchestrator": "Docker"
}

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
curl -L \
  --request PUT \
  --url '/api/core-containers/{name}/operation' \
  --header 'Content-Type: application/json' \
  --data '{"operation":"start"}'
{}

Get all images

get

/images

Responses
curl -L \
  --url '/api/images'
[
  {}
]

Inspect a image

get

/images/{name}/inspect

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

Get all networks

get

/networks

Responses
curl -L \
  --url '/api/networks'
[
  {}
]

Inspect a network

get

/networks/{name}/inspect

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

Get all volumes

get

/volumes

Responses
curl -L \
  --url '/api/volumes'
[
  {}
]

Inspect a volume

get

/volumes/{name}/inspect

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

Last updated

Was this helpful?