Cumulocity Subscriptions API

The Subscriptions API from Cumulocity — 2 operation(s) for subscriptions.

Operations 5

GET /notification2/subscriptions List Notification 2.0 Subscriptions #
POST /notification2/subscriptions Create a Subscription #
DELETE /notification2/subscriptions Delete Subscriptions by Filter #
GET /notification2/subscriptions/{id} Retrieve a Subscription #
DELETE /notification2/subscriptions/{id} Delete a Subscription #

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-subscriptions-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-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cumulocity Notification 2.0 Subscriptions API
  version: 10.20.0
  description: 'High-throughput, persistent, ordered notification streaming for production microservices. Subscribers

    declare typed subscriptions (managed object, measurements, events, alarms, operations), exchange them

    for short-lived JWT tokens, and consume via WebSocket. Survives subscriber outages by buffering messages

    on the server.

    '
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Subscriptions
paths:
  /notification2/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: List Notification 2.0 Subscriptions
      operationId: listSubscriptions
      parameters:
      - name: source
        in: query
        schema:
          type: string
      - name: context
        in: query
        schema:
          type: string
          enum:
          - tenant
          - mo
      - name: subscription
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A collection of subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionCollection'
    post:
      tags:
      - Subscriptions
      summary: Create a Subscription
      operationId: createSubscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '201':
          description: Subscription created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
    delete:
      tags:
      - Subscriptions
      summary: Delete Subscriptions by Filter
      operationId: deleteSubscriptions
      responses:
        '204':
          description: Subscriptions deleted.
  /notification2/subscriptions/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Subscriptions
      summary: Retrieve a Subscription
      operationId: getSubscription
      responses:
        '200':
          description: A single subscription.
    delete:
      tags:
      - Subscriptions
      summary: Delete a Subscription
      operationId: deleteSubscription
      responses:
        '204':
          description: Subscription deleted.
components:
  schemas:
    SubscriptionCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
    Subscription:
      type: object
      required:
      - subscription
      - context
      properties:
        id:
          type: string
          readOnly: true
        self:
          type: string
          format: uri
          readOnly: true
        subscription:
          type: string
        context:
          type: string
          enum:
          - tenant
          - mo
        source:
          type: object
          properties:
            id:
              type: string
            self:
              type: string
              format: uri
        fragmentsToCopy:
          type: array
          items:
            type: string
        subscriptionFilter:
          type: object
          properties:
            apis:
              type: array
              items:
                type: string
                enum:
                - alarms
                - events
                - eventsWithChildren
                - managedobjects
                - measurements
                - operations
            typeFilter:
              type: string
        nonPersistent:
          type: boolean
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT