API Definition | Cybus Connectware Documentation

Provides system information including features, license period and validity of the running Connectware instance

GET/api/system/info

Authorization

Response

Success

Body

timestring

versionstring

licenseobject

Request

const response = await fetch('/api/system/info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "time": "text",
  "version": "text",
  "license": {
    "name": "text"
  }
}

Retrieve preflight information

GET/api/system/preflight

Authorization

Response

Success

Body

dockerHubobject

cybusRegistryobject

cybusPortalobject

currentVersionsobject

Request

const response = await fetch('/api/system/preflight', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "dockerHub": {
    "status": false,
    "statusText": "text",
    "url": "text"
  },
  "cybusRegistry": {
    "status": false,
    "statusText": "text",
    "url": "text"
  },
  "cybusPortal": {
    "status": false,
    "statusText": "text",
    "url": "text"
  },
  "currentVersions": {}
}

Upload licensefile

PUT/api/system/licensefile

Authorization

Response

Success

Body

timestring

versionstring

licenseobject

Request

const response = await fetch('/api/system/licensefile', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "time": "text",
  "version": "text",
  "license": {
    "name": "text"
  }
}

"Endpoint to trigger a refresh of the Connectware license file with the Cybus Portal"

GET/api/system/refresh

Authorization

Response

Success

Body

timestring

versionstring

licenseobject

Request

const response = await fetch('/api/system/refresh', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "time": "text",
  "version": "text",
  "license": {
    "name": "text"
  }
}

"Endpoint to fetch health data of system container and later service container"

GET/api/system/health

Authorization

Response

Success

Body

systemobject

Request

const response = await fetch('/api/system/health', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "system": {
    "status": [
      {
        "name": "text",
        "status": "text",
        "uptime": "text"
      }
    ]
  }
}

"Endpoint to fetch VRPC health data"

GET/api/system/vrpcHealth

Authorization

Response

Success

Body

agentStatusobject

VRPCInterServiceCommunicationarray of object

Request

const response = await fetch('/api/system/vrpcHealth', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "agentStatus": {
    "agentName": "text",
    "status": "text"
  },
  "VRPCInterServiceCommunication": [
    {
      "agentName": "text",
      "providers": [
        {
          "providerName": "text",
          "reachable": false,
          "functionalityAffectedIfFailed": [
            "text"
          ]
        }
      ]
    }
  ]
}

Provides system metrics for the running Connectware instance

GET/api/system/metrics

Authorization

Response

Success

Body

object

Request

const response = await fetch('/api/system/metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Trigger to send metrics to the portal

PUT/api/system/metrics

Authorization

Response

Success

Body

object

Request

const response = await fetch('/api/system/metrics', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Provides the system's agents for the running Connectware instance

GET/api/system/agents

Authorization

Response

Success

Body

namestring

statusstring

versionstring

hostnamestring

classesobject

Request

const response = await fetch('/api/system/agents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "status": "text",
  "version": "text",
  "hostname": "text",
  "classes": {
    "instances": [
      "text"
    ]
  }
}

"List all available apps from portal according to the current Connectware license"

GET/api/marketplace/apps

Authorization

Response

Success

Body

directorystring

filenamestring

namestring

descriptionstring

homepagestring

iconstring

versionstring

providerstring

availableInLicenseboolean

publiclyOfferedboolean

createdAtstring

updatedAtstring

Request

const response = await fetch('/api/marketplace/apps', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "directory": "text",
    "filename": "text",
    "name": "text",
    "description": "text",
    "homepage": "text",
    "icon": "text",
    "version": "text",
    "provider": "text",
    "availableInLicense": false,
    "publiclyOffered": false,
    "createdAt": "text",
    "updatedAt": "text"
  }
]

"Fetch app information with given name from portal"

GET/api/marketplace/app

Authorization

Response

Success

Body

object

Request

const response = await fetch('/api/marketplace/app', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

"Fetch app meta information with given name from portal"

GET/api/marketplace/app/meta

Authorization

Response

Success

Body

object

Request

const response = await fetch('/api/marketplace/app/meta', {
    method: 'GET',
    headers: {},
});
const data = await response.json();