The Persistence service provides a permanent data storage capability for the Cloud Manager platform. It is used by the other services within the platform to store and retrieve documents containing arbitrary data. A complete set of REST endpoints is supported to manage the documents based on the CRUD model.

JSON documents

The documents managed by the Persistence service must be formatted as valid JSON objects, which are stored internally in a SaaS database. The database includes an indexing feature which improves the overall performance. Aside from the JSON formatting requirement, no additional constraints are applied to the documents. The JSON objects can contain any content and are opaque to the service.


Each client service using the Persistence service must provide a valid service token to authenticate and issue the API calls. This bearer token is passed in on each call by using the authorization request header. When using the online documentation page, you must provide the service token and click Authorize to execute a specific API call.