API Definition
Provides system information including features, license period and validity of the running Connectware instance
get
Authorizations
Responses
200
Success
application/json
400
Invalid request
get
GET /api/system/info HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"time": "text",
"version": "text",
"license": {
"name": "text",
"file": {}
}
}
Authorizations
Responses
200
Success
application/json
400
Invalid request
get
GET /api/system/preflight HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"dockerHub": {
"status": true,
"statusText": "text",
"url": "text"
},
"cybusRegistry": {
"status": true,
"statusText": "text",
"url": "text"
},
"cybusPortal": {
"status": true,
"statusText": "text",
"url": "text"
},
"currentVersions": {
"series": {}
}
}
Authorizations
Responses
200
Success
application/json
400
Invalid request
get
GET /api/system/refresh HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"time": "text",
"version": "text",
"license": {
"name": "text",
"file": {}
}
}
Authorizations
Responses
200
Success
application/json
400
Invalid request
get
GET /api/system/health HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"system": {
"status": [
{
"name": "text",
"status": "text",
"uptime": "text"
}
]
}
}
Authorizations
Responses
200
Success
application/json
get
GET /api/system/vrpcHealth HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Success
{
"agentStatus": {
"agentName": "text",
"status": "text"
},
"VRPCInterServiceCommunication": [
{
"agentName": "text",
"providers": [
{
"providerName": "text",
"reachable": true,
"functionalityAffectedIfFailed": [
"text"
]
}
]
}
]
}
Authorizations
Responses
200
Success
application/json
400
Invalid request
get
GET /api/system/agents HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"name": "text",
"status": "text",
"version": "text",
"hostname": "text",
"classes": {
"instances": [
"text"
]
}
}
Authorizations
Responses
200
Success
application/json
400
Invalid request
get
GET /api/marketplace/apps HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"directory": "text",
"filename": "text",
"name": "text",
"description": "text",
"homepage": "text",
"icon": "text",
"version": "text",
"provider": "text",
"availableInLicense": true,
"publiclyOffered": true,
"createdAt": "text",
"updatedAt": "text"
}
]
Last updated
Was this helpful?