API Definition

13KB

System Control Server Schema.yaml

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

GET/api/system/info

Authorization

ApiKeyHeader

Response

200400

Success

Body

application/json

timestring

versionstring

licenseobject

Request

JavaScriptCurlPython

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

Response

200

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

Upload licensefile

PUT/api/system/licensefile

Authorization

ApiKeyHeader

Response

200400

Success

Body

application/json

timestring

versionstring

licenseobject

Request

JavaScriptCurlPython

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

Response

200

{
  "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

ApiKeyHeader

Response

200400

Success

Body

application/json

timestring

versionstring

licenseobject

Request

JavaScriptCurlPython

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

Response

200

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

Provides system metrics for the running Connectware instance

GET/api/system/metrics

Authorization

ApiKeyHeader

Response

200400

Success

Body

application/json

object

Request

JavaScriptCurlPython

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

ApiKeyHeader

Response

200400

Success

Body

application/json

object

Request

JavaScriptCurlPython

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

"Fetch app information with given name from portal"

GET/api/marketplace/app

Authorization

ApiKeyHeader

Response

200400

Success

Body

application/json

object

Request

JavaScriptCurlPython

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

ApiKeyHeader

Response

200400

Success

Body

application/json

object

Request

JavaScriptCurlPython

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