Cumulocity Offload Configurations API

The Offload Configurations API from Cumulocity — 2 operation(s) for offload configurations.

Documentation GitHub OpenAPI

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 /service/datahub/offload List DataHub offload configurations · List Offload Configurations #

Ask an LLM

“Which DataHub offloading pipelines are configured?”

“What data is being offloaded to the data lake right now?”

Tell an agent

List all offload configurations.

Show every DataHub offloading pipeline.

POST /service/datahub/offload Set up a new DataHub offload pipeline · Create an Offload Configuration #

Ask an LLM

“How do I start offloading alarms or measurements to the data lake?”

“Can I set a schedule and target table when I create an offload pipeline?”

Tell an agent

Create an offload of {source} into dataset {targetDataset}.

Set up a {offloadType} offload of {source} on schedule {schedule}.

GET /service/datahub/offload/{id} Look up one offload configuration · Retrieve an Offload Configuration #

Ask an LLM

“How do I see the filter and schedule of one offload pipeline?”

“Which target dataset does a given offload write to?”

Tell an agent

Show me offload configuration {id}.

Get the schedule and target dataset of offload configuration {id}.

PUT /service/datahub/offload/{id} Change an offload pipeline · Update an Offload Configuration #

Ask an LLM

“Can I change the schedule of an existing offload pipeline?”

“How do I pause or change the filter on an offload configuration?”

Tell an agent

Change the schedule of offload configuration {id} to {schedule}.

Set the filter of offload configuration {id} to {filter}.

DELETE /service/datahub/offload/{id} Delete an offload pipeline · Delete an Offload Configuration #

Ask an LLM

“How do I remove an offload pipeline I no longer need?”

“Can I delete a DataHub offload configuration?”

Tell an agent destructive · confirm first

Delete offload configuration {id}.

Remove the offloading pipeline with ID {id}.

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-offload-configurations-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

openapi: 3.2.0
info:
  title: Cumulocity DataHub Offload Configurations API
  version: 2025.1
  description: 'Offload operational IoT data (measurements, events, alarms, inventory) from the Cumulocity MongoDB

    operational store into a Parquet-backed data lake queryable with ANSI SQL via Dremio. Configure offload

    pipelines, run analytics queries, and export results to BI tools (Power BI, Tableau) over JDBC/ODBC/Arrow Flight.'
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Offload Configurations
paths:
  /service/datahub/offload:
    get:
      tags:
      - Offload Configurations
      summary: List Offload Configurations
      operationId: listOffloadConfigurations
      responses:
        '200':
          description: A collection of offload configurations.
    post:
      tags:
      - Offload Configurations
      summary: Create an Offload Configuration
      operationId: createOffloadConfiguration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OffloadConfiguration'
      responses:
        '201':
          description: Offload configuration created.
  /service/datahub/offload/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Offload Configurations
      summary: Retrieve an Offload Configuration
      operationId: getOffloadConfiguration
      responses:
        '200':
          description: A single offload configuration.
    put:
      tags:
      - Offload Configurations
      summary: Update an Offload Configuration
      operationId: updateOffloadConfiguration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OffloadConfiguration'
      responses:
        '200':
          description: Offload configuration updated.
    delete:
      tags:
      - Offload Configurations
      summary: Delete an Offload Configuration
      operationId: deleteOffloadConfiguration
      responses:
        '204':
          description: Offload configuration deleted.
components:
  schemas:
    OffloadConfiguration:
      type: object
      properties:
        id:
          type: string
        self:
          type: string
          format: uri
        source:
          type: string
          enum:
          - measurements
          - events
          - alarms
          - inventory
          - operations
          - audit
        filter:
          type: string
        offloadType:
          type: string
          enum:
          - INITIAL_PLUS_INCREMENT
          - INCREMENTAL
        schedule:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - PAUSED
          - FAILED
        targetDataset:
          type: string
        partitioning:
          type: array
          items:
            type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Cumulocity Offload Configurations API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification