Welcome to CloudCannon's Developer Reference. It's organized into two parts: the files you add to your repository to configure CloudCannon, and the tools and controls for working with the CloudCannon platform.
Site configuration#
The files you add to your repository to customize how CloudCannon builds and edits your site — the configuration file, initial site settings, routing, editable regions, and the schemas and types that validate them.
- Configuration File — collections, inputs, editing interfaces, and more
- Initial Site Settings File — pre-configure SSG, hosting mode, and build settings
- Routing File — custom redirects and HTTP headers for hosted Sites
- Editable Regions — mark parts of your built HTML as editable
- Visual Editor API — connect your front end to the visual editor
- JSON Schemas and TypeScript Types — IDE autocomplete and validation
Platform#
The tools for working with the CloudCannon backend programmatically — the HTTP API, the SDK, and the CLI — plus the permissions that control what your team can do.
- CLI — manage CloudCannon from the terminal
- TypeScript SDK — a typed client for the API
- API — manage organizations, projects, sites, and builds over HTTP
- Permissions — control what your team members can do