Last updated 1 month ago
Was this helpful?
GET /system/info HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Success
{ "time": "text", "version": "text", "license": { "name": "text", "file": {} } }
GET /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": {} } }
PUT /system/licensefile HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
GET /system/refresh HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
GET /system/health HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
{ "system": { "status": [ { "name": "text", "status": "text", "uptime": "text" } ] } }
GET /system/vrpcHealth HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
{ "agentStatus": { "agentName": "text", "status": "text" }, "VRPCInterServiceCommunication": [ { "agentName": "text", "providers": [ { "providerName": "text", "reachable": true, "functionalityAffectedIfFailed": [ "text" ] } ] } ] }
GET /system/metrics HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
{}
PUT /system/metrics HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
GET /system/agents HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
[ { "name": "text", "version": "text", "hostname": "text", "classes": { "ANY_ADDITIONAL_PROPERTY": { "instances": [ "text" ] } } } ]
GET /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" } ]
GET /marketplace/app HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
GET /marketplace/app/meta HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*