# Bonitasoft Data Retention API

**Canonical:** https://apis.io/apis/bonitasoft/bonitasoft-dataretention-api/  
**Provider:** Bonitasoft — https://apis.io/providers/bonitasoft/  
**Base URL:** https://{subscription}.bonitacloud.com/bonita  
**Documentation:** https://documentation.ofelia.com/bonita/latest/api/rest-api-overview

Bonitasoft Data Retention API is one of 76 APIs that [Bonitasoft](https://apis.io/providers/bonitasoft/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Data Retention. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

Configure how Bonita automatically deletes obsolete business data. A retention rule applies to a specific business object type and defines when its instances become eligible for deletion based on a reference date (creation or last update) and a retention period in days. The data retention service runs on a configurable cron schedule. This Web REST API is available in **Enterprise editions only**, since version 11.0.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/API/retention/object` | List business object types with their retention rules |
| GET | `/API/retention/schedule` | Get the data retention schedule |
| POST | `/API/retention/rule` | Create a retention rule |
| PUT | `/API/retention/rule/{ruleId}` | Update a retention rule by ID |
| DELETE | `/API/retention/rule/{ruleId}` | Delete a retention rule by ID |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/bonitasoft/refs/heads/main/openapi/bonitasoft-dataretention-api-openapi.yml
- **APIReference** — https://api-documentation.ofelia.com/latest/
- **Documentation** — https://documentation.ofelia.com/bonita/latest/api/api-index
- **Postman** — https://api-documentation.ofelia.com/latest/postman.json
- **SourceCode** — https://github.com/bonitasoft/bonita-openapi

## Other Bonitasoft APIs (12)

- [Bonitasoft Activity API](https://apis.io/apis/bonitasoft/bonitasoft-activity-api/)
- [Bonitasoft Activity Variable API](https://apis.io/apis/bonitasoft/bonitasoft-activityvariable-api/)
- [Bonitasoft Actor API](https://apis.io/apis/bonitasoft/bonitasoft-actor-api/)
- [Bonitasoft Actor Member API](https://apis.io/apis/bonitasoft/bonitasoft-actormember-api/)
- [Bonitasoft Application API](https://apis.io/apis/bonitasoft/bonitasoft-application-api/)
- [Bonitasoft Application Menu API](https://apis.io/apis/bonitasoft/bonitasoft-applicationmenu-api/)
- [Bonitasoft Application Page API](https://apis.io/apis/bonitasoft/bonitasoft-applicationpage-api/)
- [Bonitasoft Archived Activity API](https://apis.io/apis/bonitasoft/bonitasoft-archivedactivity-api/)
- [Bonitasoft Archived Activity Variable API](https://apis.io/apis/bonitasoft/bonitasoft-archivedactivityvariable-api/)
- [Bonitasoft Archived Connector Instance API](https://apis.io/apis/bonitasoft/bonitasoft-archivedconnectorinstance-api/)
- [Bonitasoft Archived Failure API](https://apis.io/apis/bonitasoft/bonitasoft-archivedfailure-api/)
- [Bonitasoft Archived Flow Node API](https://apis.io/apis/bonitasoft/bonitasoft-archivedflownode-api/)

## Tags

Data Retention

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bonitasoft/bonitasoft-dataretention-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bonitasoft/.