Cumulocity

Cumulocity Cloud Sync API

The Cloud Sync API from Cumulocity — 1 operation(s) for cloud sync.

GitHub OpenAPI

Operations 2

GET /service/edge/cloud-sync Retrieve Cloud Sync Configuration #
PUT /service/edge/cloud-sync Update Cloud Sync Configuration #

Documentation

📖
Documentation
https://cumulocity.com/api/core/
📖
Documentation
https://cumulocity.com/docs/concepts/domain-model/
📖
Documentation
https://cumulocity.com/docs/device-integration/device-integration-introduction/
📖
Documentation
https://cumulocity.com/docs/microservice-sdk/
📖
Documentation
https://cumulocity.com/docs/reference/notifications/
📖
Documentation
https://cumulocity.com/api/datahub/
📖
Documentation
https://cumulocity.com/docs/datahub/datahub-overview/
📖
Documentation
https://cumulocity.com/api/dtm/
📖
Documentation
https://cumulocity.com/docs/digital-twin-manager/dtm-overview/
📖
Documentation
https://cumulocity.com/api/edge/
📖
Documentation
https://cumulocity.com/docs/edge/edge-overview/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/openapi/cumulocity-cloud-sync-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/asyncapi/cumulocity-notification2-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-managed-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-measurement-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-alarm-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-ld/cumulocity-context.jsonld

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-cloud-sync-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.

GitHub Google LinkedIn

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

OpenAPI Specification

cumulocity-cloud-sync-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cumulocity Edge Cloud Sync 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: Cloud Sync
paths:
  /service/edge/cloud-sync:
    get:
      tags:
      - Cloud Sync
      summary: Retrieve Cloud Sync Configuration
      operationId: getCloudSyncConfiguration
      responses:
        '200':
          description: Current cloud-sync configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudSyncConfiguration'
    put:
      tags:
      - Cloud Sync
      summary: Update Cloud Sync Configuration
      operationId: updateCloudSyncConfiguration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudSyncConfiguration'
      responses:
        '200':
          description: Cloud-sync configuration updated.
components:
  schemas:
    CloudSyncConfiguration:
      type: object
      properties:
        enabled:
          type: boolean
        targetTenantUrl:
          type: string
          format: uri
        targetTenantId:
          type: string
        syncedDataTypes:
          type: array
          items:
            type: string
            enum:
            - INVENTORY
            - MEASUREMENTS
            - EVENTS
            - ALARMS
            - OPERATIONS
            - AUDIT
        bandwidthLimitKbps:
          type: integer
        bufferingPolicy:
          type: string
          enum:
          - BLOCK
          - DROP_OLDEST
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT