System Status (API)
Provides system information including features, license period and validity of the running Connectware instance
get
Authorizations
Responses
200
Success
application/json
get
GET /api/system/info HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Success
{
"time": "text",
"version": "text",
"license": {
"name": "text",
"file": {
"id": "text",
"associatedAccount": "text",
"connectwareLicenseClass": "text",
"expiration": "2025-09-28"
},
"valid": true
}
}
Authorizations
Responses
200
Success
application/json
get
GET /api/system/preflight HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Success
{
"dockerHub": {
"status": true,
"statusText": "text",
"url": "text"
},
"cybusRegistry": {
"status": true,
"statusText": "text",
"url": "text"
},
"cybusPortal": {
"status": true,
"statusText": "text",
"url": "text"
},
"currentVersions": {
"series": {
"active": {
"latest": {
"version": "text",
"urlReleaseNotes": "text",
"installerUrl": "text"
}
}
}
}
}
Authorizations
Body
payloadstringRequired
Responses
200
Success
application/json
400
Invalid request
application/json
put
PUT /api/system/licensefile HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"payload": "text"
}
{
"time": "text",
"version": "text",
"license": {
"name": "text",
"file": {}
}
}
Authorizations
Responses
200
Success
application/json
400
Invalid request
application/json
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
Query parameters
hourlybooleanOptional
dailybooleanOptional
Responses
200
Success
application/json
400
Invalid request
get
GET /api/system/metrics HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"hourly": [
{
"timestamp": "2025-09-28",
"numberOfConnectedDatapoints": 1,
"numberOfReceivedMessages": 1
}
],
"daily": [
{
"date": "text",
"numberOfConnectedDatapoints": 1,
"numberOfReceivedMessages": 1
}
]
}
Authorizations
Responses
200
Success
application/json
400
Not able to fetch system agents
get
GET /api/system/agents HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"name": "text",
"version": "text",
"hostname": "text",
"classes": {
"ANY_ADDITIONAL_PROPERTY": {
"instances": [
"text"
]
}
}
}
]
Authorizations
Responses
200
Success
application/json
get
GET /api/marketplace/apps HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
Success
[
{
"category": "text",
"isTemplate": true,
"directory": "text",
"filename": "text",
"name": "text",
"description": "text",
"homepage": "text",
"icon": "text",
"version": "text",
"provider": "text",
"availableInLicense": true,
"publiclyOffered": true,
"createdAt": "text",
"updatedAt": "text"
}
]
Authorizations
Query parameters
directorystringRequired
filenamestringRequired
Responses
200
Success
application/json
400
Invalid request
get
GET /api/marketplace/app?directory=text&filename=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"data": "text"
}
Authorizations
Query parameters
directorystringRequired
filenamestringRequired
Responses
200
Success
application/json
400
Invalid request
get
GET /api/marketplace/app/meta?directory=text&filename=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"content": {
"data": "text"
},
"meta": {
"updatedAt": "2025-09-28T04:52:24.347Z",
"version": "text"
}
}
Last updated
Was this helpful?