API Reference

Complete reference for all OrbitKit REST API endpoints.

Account

Account status, payment method, and account deletion

GET Get account status /api/status GET Get account details /api/account DELETE Delete account /api/account GET Export account data /api/account/export

App Sites

Create, list, get, and delete app sites

GET List apps /api/apps POST Create an app /api/apps GET Get a single app /api/apps/{appId} DELETE Delete an app /api/apps/{appId}

Site

Site configuration (name, slug, description, icon)

GET Get site configuration /api/apps/{appId}/site PATCH Update site configuration /api/apps/{appId}/site POST Upload app icon /api/apps/{appId}/site/icon

Custom Domain

Custom domain setup and SSL provisioning

PUT Set custom domain /api/apps/{appId}/site/domain DELETE Remove custom domain /api/apps/{appId}/site/domain GET Check domain status /api/apps/{appId}/site/domain/status

Privacy Policy

Privacy policy wizard data

GET Get privacy policy data /api/apps/{appId}/policy PUT Save privacy policy data /api/apps/{appId}/policy

Support Page

Support page configuration

GET Get support page /api/apps/{appId}/support-page PUT Save support page /api/apps/{appId}/support-page

Data Deletion

Data deletion page configuration

GET Get data deletion page /api/apps/{appId}/deletion-page PUT Save data deletion page /api/apps/{appId}/deletion-page

Associated Domains

AASA configuration for Universal Links, App Clips, Passkeys, and Handoff

GET Get AASA configuration /api/apps/{appId}/aasa PUT Save AASA configuration /api/apps/{appId}/aasa

Smart App Banner

Smart App Banner meta tag configuration

GET Get Smart App Banner config /api/apps/{appId}/site/smart-banner PUT Save Smart App Banner config /api/apps/{appId}/site/smart-banner

Well-Known Files

Upload Apple verification files

POST Upload a well-known file /api/apps/{appId}/well-known/{fileName}

Deploy

Deploy site to production

POST Deploy site /api/apps/{appId}/deploy

Billing

Checkout, subscriptions, and payment methods

POST Subscribe an app /api/apps/{appId}/subscribe POST Create setup intent /api/setup-intent PUT Update payment method /api/payment-method POST Verify subscription after 3DS authentication /api/apps/{appId}/verify-subscription POST Cancel subscription at period end /api/apps/{appId}/cancel-subscription POST Reactivate a subscription scheduled for cancellation /api/apps/{appId}/reactivate-subscription POST Create billing portal session /api/billing-portal GET List invoices /api/invoices POST Change subscription plan /api/apps/{appId}/change-plan

TestFlight Page

TestFlight beta testing page configuration

GET Get TestFlight page configuration /api/apps/{appId}/testflight-page PUT Save TestFlight page configuration /api/apps/{appId}/testflight-page

History

Deploy history and policy version snapshots

GET List deploy history /api/apps/{appId}/deploy-history GET List policy version snapshots /api/apps/{appId}/policy-versions GET Get policy version detail /api/apps/{appId}/policy-versions/{versionId}