Get started

# Documentation

hotcfg serves versioned JSON config to your apps, with schemas, environments and rollback. Start here.

hotcfg keeps your app's remote config as versioned JSON. Each change is checked against a schema, tried in staging, promoted to production, and can be rolled back in one step. Apps read it from a plain URL, cached at the edge.

Everything is plain HTTP and JSON. The API base URL is `https://api.hotcfg.run/v1`.

## Start here

- [Quickstart](https://hotcfg.run/docs/quickstart): from sign-up to your app reading a value, in five minutes.
- [Concepts](https://hotcfg.run/docs/concepts): bins, environments, versions and keys.
- [Fetching config in your app](https://hotcfg.run/docs/guides/fetching): tested code for Swift, Kotlin, Java, JavaScript and more, which never blocks your app.

## Common tasks

- [Validate every change with a JSON Schema](https://hotcfg.run/docs/guides/schemas)
- [Test in staging, then promote to production](https://hotcfg.run/docs/guides/environments)
- [Push config from CI with GitHub Actions](https://hotcfg.run/docs/guides/ci)
- [Know what happens when hotcfg is down](https://hotcfg.run/docs/guides/outages)
- [Build kill switches and feature toggles](https://hotcfg.run/docs/guides/feature-flags)

## Recipes

- [Version and platform targeting with jq](https://hotcfg.run/docs/recipes/version-targeting)
- [iOS kill switch without an SDK](https://hotcfg.run/docs/recipes/ios-killswitch)
- [Maintenance mode for a React Native app](https://hotcfg.run/docs/recipes/react-native-maintenance)
- [Remote config for Godot](https://hotcfg.run/docs/recipes/godot)

## Reference

- [Reading a bin](https://hotcfg.run/docs/reference/reading) and [writing](https://hotcfg.run/docs/reference/writing) over HTTP
- [API keys and scopes](https://hotcfg.run/docs/reference/keys)
- [The CLI](https://hotcfg.run/docs/cli): install, log in, and every command
- [Every endpoint](https://hotcfg.run/docs/reference/api), with the [OpenAPI file](https://hotcfg.run/openapi.json)
- [Errors](https://hotcfg.run/docs/reference/errors) and [limits](https://hotcfg.run/docs/reference/limits)
- [Changelog](https://hotcfg.run/docs/changelog)

Last updated 10 November 2026
