Cumulocity Bulk Operations API

The Bulk Operations API from Cumulocity — 2 operation(s) for bulk operations.

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /devicecontrol/bulkoperations List bulk device operations · List Bulk Operations #
Ask an LLM
“Which bulk operations have been scheduled across device groups?”
“What is the progress of my running bulk operations?”
Tell an agent
List all bulk operations.
Show every bulk operation and its progress.
POST /devicecontrol/bulkoperations Send one operation to a whole device group · Create a Bulk Operation #
Ask an LLM
“How do I send the same command to every device in a group?”
“Can I ramp up a bulk operation so devices receive it gradually?”
Tell an agent
Create a bulk operation for group {groupId} using prototype {operationPrototype}.
Start a bulk operation on group {groupId} at {startDate} with a {creationRamp}-second ramp.
GET /devicecontrol/bulkoperations/{id} Look up one bulk operation · Retrieve a Bulk Operation #
Ask an LLM
“How do I check the progress of a single bulk operation?”
“Which device group is a given bulk operation targeting?”
Tell an agent
Show me bulk operation {id}.
Get the status and progress of bulk operation {id}.
PUT /devicecontrol/bulkoperations/{id} Reschedule or change a bulk operation · Update a Bulk Operation #
Ask an LLM
“Can I change the start date of a bulk operation that hasn't run yet?”
“How do I adjust the creation ramp on a scheduled bulk operation?”
Tell an agent
Move the start of bulk operation {id} to {startDate}.
Set the creation ramp of bulk operation {id} to {creationRamp} seconds.
DELETE /devicecontrol/bulkoperations/{id} Delete a bulk operation · Delete a Bulk Operation #
Ask an LLM
“How do I cancel and remove a scheduled bulk operation?”
“Can I delete a bulk operation I created by mistake?”
Tell an agent destructive · confirm first
Delete bulk operation {id}.
Remove the bulk operation with ID {id}.

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:cumulocity-bulk-operations-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-bulk-operations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cumulocity Device Control Bulk Operations API
  version: 10.20.0
  description: 'Send and track operations (commands) to devices including firmware updates, configuration changes,

    software installation, shell commands, and restart requests. Operations move through PENDING, EXECUTING,

    SUCCESSFUL, FAILED status. Bulk operations let you target an entire device group with a single request.'
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Bulk Operations
paths:
  /devicecontrol/bulkoperations:
    get:
      tags:
      - Bulk Operations
      summary: List Bulk Operations
      operationId: listBulkOperations
      responses:
        '200':
          description: A collection of bulk operations.
    post:
      tags:
      - Bulk Operations
      summary: Create a Bulk Operation
      operationId: createBulkOperation
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.bulkOperation+json:
            schema:
              $ref: '#/components/schemas/BulkOperation'
      responses:
        '201':
          description: Bulk operation created.
  /devicecontrol/bulkoperations/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Bulk Operations
      summary: Retrieve a Bulk Operation
      operationId: getBulkOperation
      responses:
        '200':
          description: A single bulk operation.
    put:
      tags:
      - Bulk Operations
      summary: Update a Bulk Operation
      operationId: updateBulkOperation
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.bulkOperation+json:
            schema:
              $ref: '#/components/schemas/BulkOperation'
      responses:
        '200':
          description: Bulk operation updated.
    delete:
      tags:
      - Bulk Operations
      summary: Delete a Bulk Operation
      operationId: deleteBulkOperation
      responses:
        '204':
          description: Bulk operation deleted.
components:
  schemas:
    BulkOperation:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        groupId:
          type: string
        failedParentId:
          type: string
        startDate:
          type: string
          format: date-time
        creationRamp:
          type: integer
        status:
          type: string
          enum:
          - ACTIVE
          - IN_PROGRESS
          - COMPLETED
          - CANCELED
        operationPrototype:
          type: object
        progress:
          type: object
          properties:
            pending:
              type: integer
            executing:
              type: integer
            successful:
              type: integer
            failed:
              type: integer
            all:
              type: integer
      additionalProperties: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT