Skip to content
Last updated

The API during Read-Only (RO) mode supports data retrieval operations while preventing any changes to the database. This mode ensures that the system remains stable and that no unintended data modifications occur while in this state.

When BillingPlatform switches to Read-Only (RO) mode, several changes occur in how the REST API handles requests:

  • Session handling: Upon a login request during RO mode, the REST API returns a fake RO_SessionId as the Session Id in the response. This session ID is used to indicate that the system is in read-only mode, and no actual session creation occurs in the database.

  • Restrictions on operations: Any requests that attempt to create, update, delete, or upsert data (e.g., POST, PUT, DELETE operations) will receive an error response with the message: Operation Not Allowed in Read Only mode. This ensures that no modifications to the database can be made during RO mode, preserving the integrity of the data.

  • Logout requests: Logout requests during RO mode are processed normally, returning a valid response to the client. However, since no real session was created (due to the issuance of a fake RO_SessionId), no session cleanup or update occurs in the database.

  • Data retrieval: Retrieve or query operations (e.g., GET requests) function as usual. The API will continue to return the requested data, as read-only operations are fully supported in this mode.

  • Session updates: During RO mode, no updates are made to user sessions in the database. This means that session activity or metadata (such as last access time) is not recorded, as all operations that would modify the session data are effectively disabled.