API Reference Complete reference for all 231 API endpoints. All routes require authentication unless marked otherwise. CMS routes use /api/projects/[id]/cms/ prefix. Public REST API uses /api/v1/[subdomain]/ prefix.
GET POST PUT PATCH DELETE
Session
API Token
Admin
Webhook Secret
None
Quick-start guide: create a project, define content types, add entries, and fetch them via the public API.
GET /docs Quick start overview Public GET /docs#authentication Authentication methods Public GET /api/v1/{subdomain}/{content-type} Your first API call API Token Connect Claude, Cursor, or any MCP-compatible AI client to your site over a hosted URL. Browser login. No tokens to paste.
GET /docs#mcp What is the AI connector? Public GET /docs#mcp-setup How to connect (per project) Public GET /docs#mcp-url What is the MCP URL? Public GET /docs#mcp-oauth First-time login (no token to paste) Public GET /docs#mcp-legacy-token Older MCP clients (manual token) Public GET /docs#mcp-troubleshooting Troubleshooting & revoking access Public Health checks, platform config, and notifications
GET /api/health Health check Public GET /api/notifications List notifications Session User identity and session management
GET /api/me Get current user Session Multi-org management and switching
GET /api/organizations List user organizations Session POST /api/organizations/switch Switch active organization Session CRUD, lifecycle management (start/stop/restart), cleanup, wake
GET /api/projects List projects Session POST /api/projects Create a project Session admin+ GET /api/projects/[id] Get project details Session PUT /api/projects/[id] Update project Session admin+ DELETE /api/projects/[id] Delete project Session admin+ POST /api/projects/[id] Start project Session editor+ POST /api/projects/[id] Stop project Session editor+ POST /api/projects/[id] Restart project Session editor+ POST /api/projects/cleanup Cleanup stale projects Session admin+ POST /api/projects/wake Wake hibernated projects Session Variables, plan, usage, onboarding, SSO
GET /api/projects/[id]/variables List environment variables Session admin+ PUT /api/projects/[id]/variables Set environment variables Session admin+ GET /api/projects/[id]/plan Get project plan info Session GET /api/projects/[id]/usage Get project usage stats Session GET /api/projects/[id]/onboarding Get onboarding status Session PUT /api/projects/[id]/onboarding Update onboarding progress Session GET /api/projects/[id]/sso Get SSO configuration Session admin+
PUT /api/projects/[id]/sso Update SSO configuration Session admin+
Create, list, download, and restore project backups
GET /api/projects/[id]/backups List backups Session admin+ POST /api/projects/[id]/backups Create a backup Session admin+ GET /api/projects/[id]/backups/[backupId] Get backup details Session admin+ GET /api/projects/[id]/backups/[backupId]/download Download backup Session admin+ POST /api/projects/[id]/backups/[backupId]/restore Restore from backup Session admin+ Add, verify, and manage custom domains for projects
GET /api/projects/[id]/domains List custom domains Session admin+
POST /api/projects/[id]/domains Add custom domain Session admin+ DELETE /api/projects/[id]/domains Remove custom domain Session admin+
POST /api/projects/[id]/domains/verify Verify domain DNS Session admin+ GET /api/projects/[id]/domains/domain-connect Domain Connect discovery Session GET /api/projects/[id]/domains/domain-connect/callback Domain Connect callback Session
Connect repos, deploy code, manage deployments
GET /api/github/install Install GitHub App Session GET /api/github/callback GitHub OAuth callback Public POST /api/projects/[id]/github/connect Connect GitHub repo to project Session admin+ GET /api/projects/[id]/github/repos List available repos Session GET /api/projects/[id]/github/dirs List repo directories Session GET /api/projects/[id]/github/config Get GitHub deploy config Session
PUT /api/projects/[id]/github/config Update GitHub deploy config Session admin+ GET /api/projects/[id]/github/deployments List deployments Session GET /api/projects/[id]/github/deployments/[deploymentId] Get deployment details Session
POST /api/projects/[id]/github/redeploy Trigger redeployment Session editor+ POST /api/projects/[id]/github/export Export project to GitHub Session admin+ Container logs and real-time SSE streaming
GET /api/projects/[id]/logs Get container logs Session GET /api/projects/[id]/start-stream Stream logs (SSE) Session AI-powered content type generation and project setup
GET /api/projects/[id]/ai-builder/conversations List AI conversations Session
POST /api/projects/[id]/ai-builder/conversations Create AI conversation Session
GET /api/projects/[id]/ai-builder Get AI messages Session POST /api/projects/[id]/ai-builder Send message to AI Session editor+ POST /api/projects/[id]/ai-builder/stream Stream AI response (SSE) Session editor+ Define and manage content type schemas
GET /api/projects/[id]/cms/content-types List content types Session POST /api/projects/[id]/cms/content-types Create content type Session editor+ PUT /api/projects/[id]/cms/content-types Update content type Session editor+ DELETE /api/projects/[id]/cms/content-types Delete content type Session editor+ GET /api/projects/[id]/cms/content-types/[uid]/view-config Get view config Session PUT /api/projects/[id]/cms/content-types/[uid]/view-config Save view config Session admin+ DELETE /api/projects/[id]/cms/content-types/[uid]/view-config Reset view config Session admin+ Reusable component schemas and their layout configuration
GET /api/projects/[id]/cms/components List components Session POST /api/projects/[id]/cms/components Create component Session admin+ GET /api/projects/[id]/cms/components/[componentUid] Get component Session PUT /api/projects/[id]/cms/components/[componentUid] Update component Session admin+ DELETE /api/projects/[id]/cms/components/[componentUid] Delete component Session admin+ GET /api/projects/[id]/cms/components/[componentUid]/view-config Get component view config Session PUT /api/projects/[id]/cms/components/[componentUid]/view-config Save component view config Session admin+ DELETE /api/projects/[id]/cms/components/[componentUid]/view-config Reset component view config Session admin+ CRUD operations for content entries
GET /api/projects/[id]/cms/entries/[uid] List entries Session POST /api/projects/[id]/cms/entries/[uid] Create entry Session editor+ GET /api/projects/[id]/cms/entries/[uid]/[docId] Get entry by document ID Session PUT /api/projects/[id]/cms/entries/[uid]/[docId] Update entry Session editor+ DELETE /api/projects/[id]/cms/entries/[uid]/[docId] Delete entry (soft) Session editor+ POST /api/projects/[id]/cms/entries/[uid]/[docId] Publish / unpublish entry Session editor+ POST /api/projects/[id]/cms/entries/[uid]/bulk Bulk operations Session editor+ GET /api/projects/[id]/cms/entries/[uid]/export Export entries Session Revisions, increments, pivot data, draft relations
GET /api/projects/[id]/cms/entries/[uid]/[docId]/revisions List entry revisions Session POST /api/projects/[id]/cms/entries/[uid]/[docId]/revisions Restore revision Session editor+ POST /api/projects/[id]/cms/entries/[uid]/[docId]/increment Increment field value Session GET /api/projects/[id]/cms/entries/[uid]/[docId]/pivot Get pivot data Session PUT /api/projects/[id]/cms/entries/[uid]/[docId]/pivot Update pivot data Session editor+ GET /api/projects/[id]/cms/entries/[uid]/[docId]/draft-relations Count draft relations Session GET /api/projects/[id]/cms/entries/[uid]/[docId]/revisions/compare Compare revisions Session POST /api/projects/[id]/cms/entries/[uid]/[docId]/revisions/create Create manual revision Session editor+ GET /api/projects/[id]/cms/entries/[uid]/[docId]/stage Get workflow stage Session PUT /api/projects/[id]/cms/entries/[uid]/[docId]/stage Transition workflow stage Session editor+ POST /api/projects/[id]/cms/entries/[uid]/import Import entries Session editor+ Group content changes into atomic releases
GET /api/projects/[id]/cms/releases List releases Session
POST /api/projects/[id]/cms/releases Create release Session editor+ GET /api/projects/[id]/cms/releases/[releaseId] Get release details Session
PUT /api/projects/[id]/cms/releases/[releaseId] Update release Session editor+
DELETE /api/projects/[id]/cms/releases/[releaseId] Delete release Session editor+
POST /api/projects/[id]/cms/releases/[releaseId]/publish Publish release Session editor+ GET /api/projects/[id]/cms/releases/[releaseId]/actions List release actions Session
POST /api/projects/[id]/cms/releases/[releaseId]/actions Add action to release Session editor+ DELETE /api/projects/[id]/cms/releases/[releaseId]/actions/[actionId] Remove action from release Session editor+
Review workflows with stages and publish gates
GET /api/projects/[id]/cms/workflows List workflows Session
POST /api/projects/[id]/cms/workflows Create workflow Session admin+ GET /api/projects/[id]/cms/workflows/[workflowId] Get workflow details Session
PUT /api/projects/[id]/cms/workflows/[workflowId] Update workflow Session admin+
DELETE /api/projects/[id]/cms/workflows/[workflowId] Delete workflow Session admin+
GET /api/projects/[id]/cms/workflows/[workflowId]/stages List workflow stages Session
PUT /api/projects/[id]/cms/workflows/[workflowId]/stages Update workflow stages Session admin+ Manage API tokens for public REST API access
GET /api/projects/[id]/cms/api-tokens List API tokens Session admin+ POST /api/projects/[id]/cms/api-tokens Create API token Session admin+ DELETE /api/projects/[id]/cms/api-tokens/[tokenId] Delete API token Session admin+
Manage end-user accounts for public-facing auth
GET /api/projects/[id]/cms/end-users List end users Session
POST /api/projects/[id]/cms/end-users Create end user Session GET /api/projects/[id]/cms/end-users/[userId] Get end user details Session
PUT /api/projects/[id]/cms/end-users/[userId] Update end user Session
DELETE /api/projects/[id]/cms/end-users/[userId] Delete end user Session
GET /api/projects/[id]/cms/end-users/roles List end-user roles Session
End-user auth settings and email templates
GET /api/projects/[id]/cms/auth-settings Get auth settings Session PUT /api/projects/[id]/cms/auth-settings Update auth settings Session admin+ GET /api/projects/[id]/cms/email-templates List email templates Session
PUT /api/projects/[id]/cms/email-templates Update email template Session admin+ Locale management for multi-language content
GET /api/projects/[id]/cms/i18n/locales List locales Session POST /api/projects/[id]/cms/i18n/locales Create locale Session admin+ PUT /api/projects/[id]/cms/i18n/locales/[localeId] Update locale Session admin+
DELETE /api/projects/[id]/cms/i18n/locales/[localeId] Delete locale Session admin+
Outgoing webhook listeners for content events
GET /api/projects/[id]/cms/webhooks List webhooks Session
POST /api/projects/[id]/cms/webhooks Create webhook Session admin+ PUT /api/projects/[id]/cms/webhooks Update webhook Session admin+
DELETE /api/projects/[id]/cms/webhooks Delete webhook Session admin+
GET /api/projects/[id]/cms/webhooks/[webhookId]/deliveries List webhook deliveries Session POST /api/projects/[id]/cms/webhooks/[webhookId]/test Test webhook Session admin+ User-defined hooks triggered on CRUD events
GET /api/projects/[id]/cms/lifecycle-hooks List lifecycle hooks Session
POST /api/projects/[id]/cms/lifecycle-hooks Create lifecycle hook Session admin+ PUT /api/projects/[id]/cms/lifecycle-hooks/[hookId] Update lifecycle hook Session admin+
DELETE /api/projects/[id]/cms/lifecycle-hooks/[hookId] Delete lifecycle hook Session admin+
NDJSON-based import/export for content migration
POST /api/projects/[id]/cms/transfer/export Export all data Session admin+ POST /api/projects/[id]/cms/transfer/import Import data Session admin+ Migration, UID generation, OpenAPI, GraphQL, OAuth, Playground
POST /api/projects/[id]/cms/migrate CMS engine migration Session admin+ POST /api/projects/[id]/cms/uid Generate unique UID Session GET /api/projects/[id]/cms/openapi OpenAPI 3.0 spec Session GET /api/projects/[id]/cms/graphql GraphQL SDL Session GET /api/projects/[id]/cms/oauth-providers List OAuth providers Session PUT /api/projects/[id]/cms/oauth-providers Update OAuth providers Session admin+ POST /api/projects/[id]/cms/playground API Playground proxy Session View and restore soft-deleted entries
GET /api/projects/[id]/cms/trash/[uid] List trashed entries Session POST /api/projects/[id]/cms/trash/[uid] Restore trashed entry Session editor+ DELETE /api/projects/[id]/cms/trash/[uid] Permanently delete entry Session editor+ Strapi-compatible public content API (requires API token)
GET /api/v1/[subdomain]/[pluralApiId] List entries (public) API Token GET /api/v1/[subdomain]/[pluralApiId]/[documentId] Get entry by ID (public) API Token POST /api/v1/[subdomain]/[pluralApiId] Create entry (public) API Token PUT /api/v1/[subdomain]/[pluralApiId]/[documentId] Update entry (public) API Token DELETE /api/v1/[subdomain]/[pluralApiId]/[documentId] Delete entry (public) API Token
POST /api/v1/[subdomain]/auth/local/register Register end user Public POST /api/v1/[subdomain]/auth/local Login end user Public POST /api/v1/[subdomain]/auth/forgot-password Forgot password Public POST /api/v1/[subdomain]/auth/reset-password Reset password Public GET /api/v1/[subdomain]/users/me Get current user profile API Token PUT /api/v1/[subdomain]/users/me Update current user profile API Token
GET /api/v1/[subdomain]/connect/[provider] OAuth connect redirect Public GET /api/v1/[subdomain]/connect/[provider]/callback OAuth callback Public
Billing, plan management, and payment via Airwallex
GET /api/subscriptions/current Get current subscription Session POST /api/subscriptions/checkout Create checkout session Session admin+ POST /api/subscriptions/cancel Cancel subscription Session admin+
POST /api/subscriptions/downgrade Downgrade plan Session admin+ POST /api/subscriptions/reactivate Reactivate cancelled subscription Session admin+
POST /api/subscriptions/update-payment Update payment method Session admin+
POST /api/subscriptions/confirm-test Confirm test subscription Session POST /api/subscriptions/confirm Confirm payment Session admin+ GET /api/subscriptions/invoices List invoices Session POST /api/subscriptions/invoices Generate invoice Session admin+ GET /api/subscriptions/proration Calculate proration Session Team members, invitations, activity log, ownership transfer
GET /api/team/members List team members Session PATCH /api/team/members/[memberId] Update member role Session admin+ DELETE /api/team/members/[memberId] Remove team member Session admin+
GET /api/team/invitations List pending invitations Session
POST /api/team/invitations Send team invitation Session admin+ PATCH /api/team/invitations Accept, decline, or resend invitation Session GET /api/team/activity Team activity log Session admin+ POST /api/team/transfer-ownership Transfer org ownership Session owner+ Project-level RBAC roles with content-type permissions, and end-user role management
GET /api/projects/[id]/roles List project roles Session POST /api/projects/[id]/roles Create custom role Session admin+ GET /api/projects/[id]/roles/[roleId] Get role detail Session PUT /api/projects/[id]/roles/[roleId] Update role Session admin+ DELETE /api/projects/[id]/roles/[roleId] Delete custom role Session admin+
POST /api/projects/[id]/roles/assign Assign role to user Session admin+ DELETE /api/projects/[id]/roles/assign Remove role assignment Session admin+ GET /api/projects/[id]/cms/end-users/roles List end-user roles Session POST /api/projects/[id]/cms/end-users/roles Create end-user role Session admin+ PUT /api/projects/[id]/cms/end-users/roles Update end-user role Session admin+ Platform admin operations (requires platform_admins role)
GET /api/admin/me Get admin status Admin GET /api/admin/users List all platform users Admin readonly+
GET /api/admin/users/[id] Get user details Admin readonly+
PUT /api/admin/users/[id] Update user (admin) Admin superadmin+
GET /api/admin/instances List all project instances Admin readonly+ POST /api/admin/instances/[id]/start Force-start instance Admin platform+
POST /api/admin/instances/[id]/stop Force-stop instance Admin platform+
POST /api/admin/instances/[id]/restart Force-restart instance Admin platform+
GET /api/admin/customers List customers Admin superadmin+ GET /api/admin/customers/[id] Get customer details Admin superadmin+
PUT /api/admin/customers/[id]/plan Update customer plan Admin superadmin+ GET /api/admin/capacity Cluster capacity Admin readonly+ GET /api/admin/overview Platform overview Admin readonly+ GET /api/admin/platform-settings Get platform settings Admin superadmin+
PUT /api/admin/platform-settings Update platform settings Admin superadmin+
GET /api/admin/activity Platform audit log Admin readonly+
GET /api/admin/logs System logs Admin readonly+
GET /api/admin/access-review Access review Admin superadmin+ POST /api/admin/impersonate Impersonate user Admin superadmin+ GET /api/admin/strapi-features Strapi feature flags Admin readonly+
DELETE /api/admin/projects/[id]/delete Force-delete project (admin) Admin superadmin+ POST /api/admin/bulk/downgrade-all Bulk downgrade all orgs Admin superadmin+
POST /api/admin/bulk/purge-projects Bulk purge projects Admin superadmin+ Webhook receivers for external services
POST /api/webhooks/clerk Clerk webhook Webhook Secret POST /api/webhooks/github GitHub webhook Webhook Secret POST /api/webhooks/airwallex Airwallex webhook Webhook Secret Internal APIs for background jobs and feature flags
POST /api/internal/collect-usage Collect usage metrics Public GET /api/internal/features Get feature flags Session