# Cumulocity System options API

**Canonical:** https://apis.io/apis/cumulocity/cumulocity-system-options-api/  
**Provider:** Cumulocity — https://apis.io/providers/cumulocity/  
**Base URL:** mqtt://{tenant}.cumulocity.com:1883  
**Documentation:** https://cumulocity.com/docs/device-integration/mqtt/

Cumulocity System options API is one of 62 APIs that [Cumulocity](https://apis.io/providers/cumulocity/) publishes on the [APIs.io](https://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 System options. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, an AsyncAPI specification, and 4 JSON Schemas.

API methods to retrieve the read-only properties predefined in the platform's configuration. For security reasons, a few system options are considered secured, which means the user must have the required role **ROLE_OPTION_MANAGEMENT_ADMIN** to read their values. List of options: | Category | Key | Considered as secured | |:-------------------------:|:------------------------------|:----------------------| | password | green.min-length | yes | | two-factor-authentication | pin.validity | yes | | two-factor-authentication | token.length | yes | | two-factor-authentication | token.validity | yes | | authentication | badRequestCounter | yes | | files | microservice.zipped.max.size | yes | | files | microservice.unzipped.max.size| yes | | files | webapp.zipped.max.size | yes | | files | webapp.unzipped.max.size | yes | | two-factor-authentication | enforced | no | | reportMailer | available | no | | system | version | no | | plugin | eventprocessing.enabled | no | | password | limit.validity | no | | password | enforce.strength | no | | two-factor-authentication | strategy | no | | two-factor-authentication | pin.length | no | | two-factor-authentication | enabled | no | | two-factor-authentication | enforced.group | no | | two-factor-authentication | tenant-scope-settings.enabled | no | | two-factor-authentication | logout-on-browser-termination | no | | connectivity | microservice.url | no | | support-user | enabled | no | | support | url | no | | trackers | supported.models | no | | encoding | test | no | | data-broker | bootstrap.period | no | | files | max.size | no | | device-control | bulkoperation.creationramp | no | | gainsight | api.key | no | | cep | deprecation.alarm | no | | remoteaccess | pass-through.enabled | no | | device-registration | security-token.policy | no |

## Operations (2)

| Method | Path | Summary |
|---|---|---|
| GET | `/tenant/system/options` | Retrieve all system options |
| GET | `/tenant/system/options/{category}/{key}` | Retrieve a specific system option |

## Machine-readable artifacts (18)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/openapi/cumulocity-system-options-api-openapi.yml
- **Documentation** — https://cumulocity.com/api/core/
- **Documentation** — https://cumulocity.com/docs/concepts/domain-model/
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-managed-object-schema.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-ld/cumulocity-context.jsonld
- **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
- **Documentation** — https://cumulocity.com/docs/device-integration/device-integration-introduction/
- **Documentation** — https://cumulocity.com/docs/microservice-sdk/
- **Documentation** — https://cumulocity.com/docs/reference/notifications/
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/asyncapi/cumulocity-notification2-asyncapi.yml
- **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/

## Other Cumulocity APIs (12)

- [Cumulocity MQTT and SmartREST API](https://apis.io/apis/cumulocity/cumulocity-mqtt-api/)
- [Cumulocity MQTT Service API](https://apis.io/apis/cumulocity/cumulocity-mqtt-service-api/)
- [Cumulocity Alarms API](https://apis.io/apis/cumulocity/cumulocity-alarms-api/)
- [Cumulocity Application Binaries API](https://apis.io/apis/cumulocity/cumulocity-application-binaries-api/)
- [Cumulocity Applications API](https://apis.io/apis/cumulocity/cumulocity-applications-api/)
- [Cumulocity Asset Instances API](https://apis.io/apis/cumulocity/cumulocity-asset-instances-api/)
- [Cumulocity Asset Models API](https://apis.io/apis/cumulocity/cumulocity-asset-models-api/)
- [Cumulocity Binaries API](https://apis.io/apis/cumulocity/cumulocity-binaries-api/)
- [Cumulocity Bulk Operations API](https://apis.io/apis/cumulocity/cumulocity-bulk-operations-api/)
- [Cumulocity Cloud Sync API](https://apis.io/apis/cumulocity/cumulocity-cloud-sync-api/)
- [Cumulocity Current User API](https://apis.io/apis/cumulocity/cumulocity-current-user-api/)
- [Cumulocity Device Credentials API](https://apis.io/apis/cumulocity/cumulocity-device-credentials-api/)

## Tags

System options

---

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