Cased

Cased developer and API documentation

Add a comprehensive, high-signal, and tamper-proof audit trail to any application in minutes. Give your compliance, security, and customer support teams the information they need.

Test and live modes

Cased provides test and live modes with separate API keys so that you can experiment without impacting your production data.

The difference between test and live mode

Test and live mode function almost identically except test mode doesn't come with the same performance guarantees as live mode. For example, Cased may need to purge test mode data at various intervals. Production data that is mission critical should always be published using a live API key.

📘

You can view test data by toggling the Dashboard’s Viewing test data option.

Why you should use test mode

Audit trails are immutable, meaning once an event is published you cannot remove or edit it. As you'll learn in designing audit trail events it's important to consider the structure of the data included in your audit trail events. Experimenting in test mode is the best way to polish your events before you start sending them to your production environment.

When you should use live mode

After you're ready to publish production data to Cased you should enable live mode, complete any configuration, and start using live API keys.

Turning on and off test mode

To enable test mode, toggle on Viewing test data in the main navigation:

It is always clear when you are in test mode—you will see a banner at the top of the page, and the toggle in the main navigation will be turned on:

Updated about a month ago


Test and live modes


Cased provides test and live modes with separate API keys so that you can experiment without impacting your production data.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.