Cumulocity

Cumulocity External IDs API

The External IDs API from Cumulocity — 2 operation(s) for external ids.

Documentation GitHub OpenAPI

Operations 4

GET /identity/externalIds/{type}/{externalId} Retrieve an External ID #

DELETE /identity/externalIds/{type}/{externalId} Delete an External ID #

GET /identity/globalIds/{id}/externalIds List External IDs for Global ID #

POST /identity/globalIds/{id}/externalIds Create an External ID #

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-external-ids-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 Identity External IDs API
  version: 10.20.0
  description: 'Link external identifiers (IMEI, serial number, MAC, ICCID, c8y_Serial, etc.) to Cumulocity managed

    object IDs. The Identity API is the primary lookup table used by device bootstrap, MQTT auto-registration,

    and any integration translating provider-specific IDs to Cumulocity IDs.

    '
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: External IDs
paths:
  /identity/externalIds/{type}/{externalId}:
    parameters:
    - name: type
      in: path
      required: true
      schema:
        type: string
    - name: externalId
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - External IDs
      summary: Retrieve an External ID
      operationId: getExternalId
      responses:
        '200':
          description: A single external ID record.
          content:
            application/vnd.com.nsn.cumulocity.externalId+json:
              schema:
                $ref: '#/components/schemas/ExternalId'
    delete:
      tags:
      - External IDs
      summary: Delete an External ID
      operationId: deleteExternalId
      responses:
        '204':
          description: External ID deleted.
  /identity/globalIds/{id}/externalIds:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - External IDs
      summary: List External IDs for Global ID
      operationId: listExternalIdsForGlobalId
      responses:
        '200':
          description: A collection of external IDs.
          content:
            application/vnd.com.nsn.cumulocity.externalIdCollection+json:
              schema:
                $ref: '#/components/schemas/ExternalIdCollection'
    post:
      tags:
      - External IDs
      summary: Create an External ID
      operationId: createExternalId
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.externalId+json:
            schema:
              $ref: '#/components/schemas/ExternalId'
      responses:
        '201':
          description: External ID created.
components:
  schemas:
    ExternalIdCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        externalIds:
          type: array
          items:
            $ref: '#/components/schemas/ExternalId'
    ExternalId:
      type: object
      properties:
        self:
          type: string
          format: uri
        externalId:
          type: string
        type:
          type: string
        managedObject:
          type: object
          properties:
            id:
              type: string
            self:
              type: string
              format: uri
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Cumulocity External IDs API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources