--- description: The Capawesome Cloud API lets you manage apps programmatically — Live Updates, Native Builds, App Submissions, and more, over a REST API. title: Capawesome Cloud API - Capawesome image: https://capawesome.io/docs/assets/images/social/cloud/api.png --- [ Skip to content](#api) [ 🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode.](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories # API[¶](#api "Permanent link") The Capawesome Cloud API lets you manage your apps and resources programmatically — apps, builds, bundles, channels, devices, deployments, and more. It's a REST API that speaks JSON, and it's the same API the [CLI](/docs/cloud/cli/) and [SDKs](/docs/cloud/sdks/node/) are built on. Reach for it directly when you need something those tools don't cover, or when you're integrating Capawesome Cloud into your own backend. ## Base URL[¶](#base-url "Permanent link") `[](#%5F%5Fcodelineno-0-1)https://api.cloud.capawesome.io ` The API is versioned through the URL path. All endpoints below the base URL live under a version segment such as `/v1`, so an existing integration keeps working when a new version ships. ## Authentication[¶](#authentication "Permanent link") Requests are authenticated with an [API token](/docs/cloud/accounts/tokens/). Create a token in the Console and send it as a bearer token in the `Authorization` header: `[](#%5F%5Fcodelineno-1-1)curl https://api.cloud.capawesome.io/v1/apps \ [](#%5F%5Fcodelineno-1-2) -H "Authorization: Bearer $CAPAWESOME_TOKEN" ` Keep tokens secret Never commit a token or expose it in client-side code. Store it as a secret or environment variable, and rotate it if it might have leaked. ## Requests and responses[¶](#requests-and-responses "Permanent link") The API accepts and returns JSON. For requests with a body, send `Content-Type: application/json`: `[](#%5F%5Fcodelineno-2-1)curl -X POST https://api.cloud.capawesome.io/v1/apps \ [](#%5F%5Fcodelineno-2-2) -H "Authorization: Bearer $CAPAWESOME_TOKEN" \ [](#%5F%5Fcodelineno-2-3) -H "Content-Type: application/json" \ [](#%5F%5Fcodelineno-2-4) -d '{ "name": "My App" }' ` ## Pagination[¶](#pagination "Permanent link") Endpoints that return a list of resources are paginated. Use the `limit` and `offset` query parameters to control how many items you get back and where the page starts: `[](#%5F%5Fcodelineno-3-1)curl "https://api.cloud.capawesome.io/v1/apps?limit=20&offset=40" \ [](#%5F%5Fcodelineno-3-2) -H "Authorization: Bearer $CAPAWESOME_TOKEN" ` ## Errors[¶](#errors "Permanent link") The API uses standard HTTP status codes: `2xx` for success, `4xx` for client errors — such as `401` for a missing or invalid token and `404` for a resource that doesn't exist — and `5xx` for server-side problems. Error responses include a JSON body describing what went wrong, so check both the status code and the message when a request fails. ## Reference[¶](#reference "Permanent link") The full, interactive endpoint reference is published as an OpenAPI/Swagger specification. You can browse every endpoint, see the exact request and response shapes, and try calls directly in the browser: [API Reference](https://api.cloud.capawesome.io/docs) Because it's an OpenAPI spec, you can also import it into tools like Postman or feed it to a client generator to scaffold a typed SDK in your language of choice. ## Next steps[¶](#next-steps "Permanent link") * [CLI](/docs/cloud/cli/) — manage your apps from the command line. * [Node.js SDK](/docs/cloud/sdks/node/) and [Python SDK](/docs/cloud/sdks/python/) — call the API from your own code. * [API tokens](/docs/cloud/accounts/tokens/) — create and manage the tokens that authenticate your requests. June 8, 2026 Back to top