The CloudCannon SDK

@cloudcannon/sdk is the REST API client the CloudCannon CLI is built on. It exposes a hierarchy of sub-clients over the API, plus a typed fetch that reaches endpoints no sub-client wraps.

Reach for it when the work is programmatic. Reach for the CLI when the work is a shell command.

When to use

• Calling the CloudCannon API from a script, a build step, or a service
• Operating over many sites or organisations in one pass
• Reaching a surface the CLI does not expose — DAMs, backups, sync history and pulls, site scans, screenshots, provider connect/disconnect, site.copy, site.delete
• Handling API failures by type rather than by exit code
• Finding out which methods exist, and what they take

When not to use