Cumulocity Tenant Options API

The Tenant Options API from Cumulocity — 2 operation(s) for tenant options.

Documentation GitHub OpenAPI

Business capability

Tenant Configuration Management BC-4230.20

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 /tenant/options List tenant configuration options · List Tenant Options #

Ask an LLM

“What configuration options are set on my tenant?”

“Which tenant option keys and values exist?”

Tell an agent

List all tenant options.

Show every tenant option category, key and value.

POST /tenant/options Add a tenant configuration option · Create a Tenant Option #

Ask an LLM

“How do I store a new configuration value on my tenant?”

“Can I add a tenant option under my own category?”

Tell an agent

Create tenant option {key} in category {category} with value {value}.

Add a new option {category}.{key} set to {value}.

GET /tenant/options/{category}/{key} Read one tenant option · Retrieve a Tenant Option #

Ask an LLM

“What value is a specific tenant option set to?”

“How do I read one option by its category and key?”

Tell an agent

Show tenant option {key} in category {category}.

Get the value of option {category}/{key}.

PUT /tenant/options/{category}/{key} Change a tenant option value · Update a Tenant Option #

Ask an LLM

“How do I change the value of an existing tenant option?”

“Can I overwrite a configuration value stored on the tenant?”

Tell an agent

Set tenant option {category}/{key} to {value}.

Change the existing option {key} in category {category} to {value}.

DELETE /tenant/options/{category}/{key} Delete a tenant option · Delete a Tenant Option #

Ask an LLM

“How do I remove a tenant option I no longer use?”

“Can I delete one configuration option by category and key?”

Tell an agent destructive · confirm first

Delete tenant option {key} in category {category}.

Remove option {category}/{key} from the tenant.

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-tenant-options-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 Tenant Tenant Options API
  version: 10.20.0
  description: 'Manage Cumulocity tenants (sub-tenants in enterprise and management hierarchies), tenant options

    (key-value config including encrypted secrets), tenant applications, and tenant usage statistics.'
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Tenant Options
paths:
  /tenant/options:
    get:
      tags:
      - Tenant Options
      summary: List Tenant Options
      operationId: listTenantOptions
      responses:
        '200':
          description: A collection of tenant options.
    post:
      tags:
      - Tenant Options
      summary: Create a Tenant Option
      operationId: createTenantOption
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.option+json:
            schema:
              $ref: '#/components/schemas/TenantOption'
      responses:
        '201':
          description: Tenant option created.
  /tenant/options/{category}/{key}:
    parameters:
    - name: category
      in: path
      required: true
      schema:
        type: string
    - name: key
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Tenant Options
      summary: Retrieve a Tenant Option
      operationId: getTenantOption
      responses:
        '200':
          description: A single tenant option.
    put:
      tags:
      - Tenant Options
      summary: Update a Tenant Option
      operationId: updateTenantOption
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.option+json:
            schema:
              $ref: '#/components/schemas/TenantOption'
      responses:
        '200':
          description: Tenant option updated.
    delete:
      tags:
      - Tenant Options
      summary: Delete a Tenant Option
      operationId: deleteTenantOption
      responses:
        '204':
          description: Tenant option deleted.
components:
  schemas:
    TenantOption:
      type: object
      required:
      - category
      - key
      - value
      properties:
        self:
          type: string
          format: uri
        category:
          type: string
        key:
          type: string
        value:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Cumulocity Tenant Options 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