Resources (API)

Get all service containers

get
Responses
200
All service containers
application/json
Responseobject[]
get
GET /api/containers HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect service container

get
Responses
200
Service container inspect
application/json
Responseobject
get
GET /api/containers/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get service container logs

get
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
get
GET /api/containers/{name}/logs HTTP/1.1
Host: 
Accept: */*
text

Get container state

get
Responses
200
Service container state
application/json
Responseobject
get
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
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
Path parameters
namestringRequired

Name of the service container

Body
operationstring · enumRequiredPossible values:
Responses
200
Service container inspection after operation is performed
application/json
Responseobject
put
PUT /api/containers/{name}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}
{}

Get all core containers

get
Responses
200
All core containers
application/json
Responseobject[]
get
GET /api/core-containers HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect core container

get
Responses
200
Core container inspect
application/json
Responseobject
get
GET /api/core-containers/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get core container logs

get
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
get
GET /api/core-containers/{name}/logs HTTP/1.1
Host: 
Accept: */*
text

Get core container state

get
Responses
200
Core Container state
application/json
Responseobject
get
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
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
Path parameters
namestringRequired

Name of the core container

Body
operationstring · enumRequiredPossible values:
Responses
200
Core container inspection after operation is performed
application/json
Responseobject
put
PUT /api/core-containers/{name}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}
{}

Get all images

get
Responses
200
All images
application/json
Responseobject[]
get
GET /api/images HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect a image

get
Responses
200
Image inspect
application/json
Responseobject
get
GET /api/images/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get all networks

get
Responses
200
All networks
application/json
Responseobject[]
get
GET /api/networks HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect a network

get
Responses
200
Network inspect
application/json
Responseobject
get
GET /api/networks/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get all volumes

get
Responses
200
All volumes
application/json
Responseobject[]
get
GET /api/volumes HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect a volume

get
Responses
200
Volume inspect
application/json
Responseobject
get
GET /api/volumes/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Last updated

Was this helpful?