How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cumulocity Retention Rules API

The Retention Rules API from Cumulocity — 2 operation(s) for retention rules.

Cumulocity Retention Rules API is one of 39 APIs that Cumulocity publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Retention Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, an AsyncAPI specification, and 4 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 10.20.0.

Requests are made against a single base URL, https://{tenant}.cumulocity.com.

5 operations 2 paths 1 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
10.20.0
Base URL
https://{tenant}.cumulocity.com/inventory
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Cumulocity Retention Rules API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Retention Rules 5
GET
/retention/retentions
List Retention Rules
listRetentionRules → 200
POST
/retention/retentions
Create a Retention Rule
createRetentionRule body → 201
GET
/retention/retentions/{id}
Retrieve a Retention Rule
getRetentionRule 1 param → 200
PUT
/retention/retentions/{id}
Update a Retention Rule
updateRetentionRule 1 param body → 200
DELETE
/retention/retentions/{id}
Delete a Retention Rule
deleteRetentionRule 1 param → 204

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is RetentionRule (8 properties). Each schema is shown below with its type and property counts.

RetentionRule
object
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cumulocity-retention-rules-api-openapi.yml Raw ↑

Other APIs Cumulocity publishes across the network.

Cumulocity MQTT and SmartREST API
Cumulocity MQTT Service API
Cumulocity Alarms API
Cumulocity Application Binaries API
Cumulocity Applications API
Cumulocity Asset Instances API
Cumulocity Asset Models API
Cumulocity Audit Records API
Cumulocity Bayeux Handshake API
Cumulocity Binaries API
Cumulocity Bootstrap Users API
Cumulocity Bulk Operations API
Where this information came from

This is an independent, third-party profile of Cumulocity Retention Rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.