API Definition
Path parameters
namestringRequired
Name of the service container
Query parameters
timestampsstring · enumOptionalPossible values:
If the logs should yield timestamp
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
GET /api/containers/{name}/logs HTTP/1.1
Host:
Accept: */*
text
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"
}
Path parameters
namestringRequired
Name of the service container
Body
operationstring · enumRequiredPossible values:
Responses
200
Service container inspection after operation is performed
application/json
Responseobject
400
Invalid request
404
Service container not found
put
PUT /api/containers/{name}/operation HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"operation": "start"
}
{}
Path parameters
namestringRequired
Name of the core container
Query parameters
timestampsstring · enumOptionalPossible values:
If the logs should yield timestamp
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
GET /api/core-containers/{name}/logs HTTP/1.1
Host:
Accept: */*
text
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"
}
Path parameters
namestringRequired
Name of the core container
Body
operationstring · enumRequiredPossible values:
Responses
200
Core container inspection after operation is performed
application/json
Responseobject
400
Invalid request
404
Core container not found
put
PUT /api/core-containers/{name}/operation HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"operation": "start"
}
{}
Last updated
Was this helpful?