Cumulocity System API

The System API from Cumulocity — 2 operation(s) for system.

Operations 2

GET /service/edge/system Retrieve Edge System Status #
POST /service/edge/system/restart Restart the Edge System #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cumulocity-system-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cumulocity-system-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cumulocity Edge System API
  version: 10.18.0
  description: 'Single-node on-premises deployment of Cumulocity that runs the full platform locally (inventory,

    events, measurements, alarms, streaming analytics, UI) and optionally syncs selected data to a cloud

    tenant. Targets factory floors, vessels, and regulated/air-gapped environments.

    '
servers:
- url: https://edge.local
- url: https://{edgeHost}
  variables:
    edgeHost:
      default: edge.local
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: System
paths:
  /service/edge/system:
    get:
      tags:
      - System
      summary: Retrieve Edge System Status
      operationId: getEdgeSystemStatus
      responses:
        '200':
          description: System status including version, uptime, disk, and service health.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EdgeSystemStatus'
  /service/edge/system/restart:
    post:
      tags:
      - System
      summary: Restart the Edge System
      operationId: restartEdge
      responses:
        '202':
          description: Restart requested.
components:
  schemas:
    EdgeSystemStatus:
      type: object
      properties:
        version:
          type: string
        edition:
          type: string
          enum:
          - CONNECTED
          - AIR_GAPPED
        uptime:
          type: integer
          description: Seconds since boot.
        services:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              status:
                type: string
                enum:
                - RUNNING
                - STOPPED
                - FAILED
        storage:
          type: object
          properties:
            totalBytes:
              type: integer
            usedBytes:
              type: integer
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT