Cumulocity

Cumulocity Tenants API

The Tenants API from Cumulocity — 2 operation(s) for tenants.

GitHub OpenAPI
Business capability
Tenant Provisioning & Lifecycle BC-4230.10

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/tenants List subtenants · List Tenants #
Ask an LLM
“Which subtenants exist under my enterprise tenant?”
“What customer tenants have I created?”
Tell an agent
List all tenants.
Show every subtenant I manage.
POST /tenant/tenants Create a subtenant · Create a Tenant #
Ask an LLM
“How do I create a new customer tenant with its own admin?”
“Can I set the domain and admin email when creating a tenant?”
Tell an agent
Create a tenant for {company} on domain {domain}.
Create tenant {company} with admin {adminName} at {adminEmail}.
GET /tenant/tenants/{tenantId} Look up one tenant · Retrieve a Tenant #
Ask an LLM
“How do I see the details of one subtenant?”
“What domain and status does a given tenant have?”
Tell an agent
Show me tenant {tenantId}.
Get the domain, status and contact of tenant {tenantId}.
PUT /tenant/tenants/{tenantId} Change a tenant's details · Update a Tenant #
Ask an LLM
“Can I suspend a subtenant or change its contact details?”
“How do I update the company name on a tenant?”
Tell an agent
Set the status of tenant {tenantId} to {status}.
Change the contact of tenant {tenantId} to {contactName}, {contactPhone}.
DELETE /tenant/tenants/{tenantId} Delete a tenant · Delete a Tenant #
Ask an LLM
“How do I permanently remove a subtenant?”
“Can I delete a customer tenant that's been closed?”
Tell an agent destructive · confirm first
Delete tenant {tenantId}.
Remove subtenant {tenantId} permanently.

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-tenants-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:cumulocity-tenants-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-tenants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cumulocity Tenant Tenants 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: Tenants
paths:
  /tenant/tenants:
    get:
      tags:
      - Tenants
      summary: List Tenants
      operationId: listTenants
      responses:
        '200':
          description: A collection of tenants.
          content:
            application/vnd.com.nsn.cumulocity.tenantCollection+json:
              schema:
                $ref: '#/components/schemas/TenantCollection'
    post:
      tags:
      - Tenants
      summary: Create a Tenant
      operationId: createTenant
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.tenant+json:
            schema:
              $ref: '#/components/schemas/Tenant'
      responses:
        '201':
          description: Tenant created.
  /tenant/tenants/{tenantId}:
    parameters:
    - name: tenantId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Tenants
      summary: Retrieve a Tenant
      operationId: getTenant
      responses:
        '200':
          description: A single tenant.
          content:
            application/vnd.com.nsn.cumulocity.tenant+json:
              schema:
                $ref: '#/components/schemas/Tenant'
    put:
      tags:
      - Tenants
      summary: Update a Tenant
      operationId: updateTenant
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.tenant+json:
            schema:
              $ref: '#/components/schemas/Tenant'
      responses:
        '200':
          description: Tenant updated.
    delete:
      tags:
      - Tenants
      summary: Delete a Tenant
      operationId: deleteTenant
      responses:
        '204':
          description: Tenant deleted.
components:
  schemas:
    Tenant:
      type: object
      properties:
        id:
          type: string
        self:
          type: string
          format: uri
        company:
          type: string
        domain:
          type: string
        adminName:
          type: string
        adminEmail:
          type: string
        contactName:
          type: string
        contactPhone:
          type: string
        parent:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - SUSPENDED
        creationTime:
          type: string
          format: date-time
        customProperties:
          type: object
        allowCreateTenants:
          type: boolean
    TenantCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        tenants:
          type: array
          items:
            $ref: '#/components/schemas/Tenant'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT