API Definition

PreviousSystem Health NextBackup and Restore

Last updated 2 months ago

Was this helpful?

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

get

/system/info

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/system/info' \
  --header 'Authorization: YOUR_API_KEY'

200

400

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

Success

Retrieve preflight information

get

/system/preflight

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/system/preflight' \
  --header 'Authorization: YOUR_API_KEY'

200

400

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

Success

Upload licensefile

put

/system/licensefile

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/system/licensefile' \
  --header 'Authorization: YOUR_API_KEY'

200

400

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

Success

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

get

/system/refresh

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/system/refresh' \
  --header 'Authorization: YOUR_API_KEY'

200

400

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

Success

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

get

/system/health

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/system/health' \
  --header 'Authorization: YOUR_API_KEY'

200

400

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

Success

"Endpoint to fetch VRPC health data"

get

/system/vrpcHealth

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/system/vrpcHealth' \
  --header 'Authorization: YOUR_API_KEY'

200

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

Success

Provides system metrics for the running Connectware instance

get

/system/metrics

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/system/metrics' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{}

Success

Trigger to send metrics to the portal

put

/system/metrics

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/system/metrics' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{}

Success

Provides the system's agents for the running Connectware instance

get

/system/agents

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/system/agents' \
  --header 'Authorization: YOUR_API_KEY'

200

400

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

Success

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

get

/marketplace/apps

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/marketplace/apps' \
  --header 'Authorization: YOUR_API_KEY'

200

400

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

Success

"Fetch app information with given name from portal"

get

/marketplace/app

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/marketplace/app' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{}

Success

"Fetch app meta information with given name from portal"

get

/marketplace/app/meta

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/marketplace/app/meta' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{}

Success