API Definition

13KB

System Control Server Schema.yaml

Open

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

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

timestringOptional

versionstringOptional

400

Invalid request

get

/system/info

HTTPcURLJavaScriptPython

GET /api/system/info HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

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

Retrieve preflight information

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

400

Invalid request

get

/system/preflight

HTTPcURLJavaScriptPython

GET /api/system/preflight HTTP/1.1
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": {}
  }
}

Upload licensefile

put

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

timestringOptional

versionstringOptional

400

Invalid request

put

/system/licensefile

HTTPcURLJavaScriptPython

PUT /api/system/licensefile HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

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

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

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

timestringOptional

versionstringOptional

400

Invalid request

get

/system/refresh

HTTPcURLJavaScriptPython

GET /api/system/refresh HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

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

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

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

400

Invalid request

get

/system/health

HTTPcURLJavaScriptPython

GET /api/system/health HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

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

"Endpoint to fetch VRPC health data"

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

get

/system/vrpcHealth

HTTPcURLJavaScriptPython

GET /api/system/vrpcHealth HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Success

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

Provides system metrics for the running Connectware instance

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

objectOptional

400

Invalid request

get

/system/metrics

HTTPcURLJavaScriptPython

GET /api/system/metrics HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}

Trigger to send metrics to the portal

put

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

objectOptional

400

Invalid request

put

/system/metrics

HTTPcURLJavaScriptPython

PUT /api/system/metrics HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}

Provides the system's agents for the running Connectware instance

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

namestringOptional

statusstringOptional

versionstringOptional

hostnamestringOptional

400

Invalid request

get

/system/agents

HTTPcURLJavaScriptPython

GET /api/system/agents HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

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

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

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

directorystringOptional

filenamestringOptional

namestringOptional

descriptionstringOptional

homepagestringOptional

iconstringOptional

versionstringOptional

providerstringOptional

availableInLicensebooleanOptional

publiclyOfferedbooleanOptional

createdAtstringOptional

updatedAtstringOptional

400

Invalid request

get

/marketplace/apps

HTTPcURLJavaScriptPython

GET /api/marketplace/apps HTTP/1.1
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"
  }
]

"Fetch app information with given name from portal"

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

objectOptional

400

Invalid request

get

/marketplace/app

HTTPcURLJavaScriptPython

GET /api/marketplace/app HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}

"Fetch app meta information with given name from portal"

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Success

application/json

objectOptional

400

Invalid request

get

/marketplace/app/meta

HTTPcURLJavaScriptPython

GET /api/marketplace/app/meta HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{}