Help · The API
API reference
Every operation a script, a CI job or another service calls, by group. It is rendered from the description this Studio publishes at /api/v1/openapi.json (version 0.1.0), which also lists the operations that serve the dashboard.
Drafts and content
Drafts, content, review and publishing.
- GET /api/v1/projects/{project}/drafts List project drafts
- POST /api/v1/projects/{project}/drafts Create a project draft
- GET /api/v1/projects/{project}/drafts/{draft} Get a project draft
- PATCH /api/v1/projects/{project}/drafts/{draft} Update a project draft
- DELETE /api/v1/projects/{project}/drafts/{draft} Delete a project draft
- GET /api/v1/projects/{project}/drafts/{draft}/comments List draft comments
- POST /api/v1/projects/{project}/drafts/{draft}/comments Create a draft comment
- GET /api/v1/projects/{project}/drafts/{draft}/compare Compare a draft against live
- GET /api/v1/projects/{project}/drafts/{draft}/content/{collection} List draft content in a collection
- POST /api/v1/projects/{project}/drafts/{draft}/content/{collection} Create a draft content entry
- GET /api/v1/projects/{project}/drafts/{draft}/content/{collection}/{slug} Get a draft content entry
- PUT /api/v1/projects/{project}/drafts/{draft}/content/{collection}/{slug} Write a draft content entry
- DELETE /api/v1/projects/{project}/drafts/{draft}/content/{collection}/{slug} Delete a draft content entry
- POST /api/v1/projects/{project}/drafts/{draft}/content/{collection}/{slug}/rename Rename a draft content entry
- GET /api/v1/projects/{project}/drafts/{draft}/history Get draft history
- POST /api/v1/projects/{project}/drafts/{draft}/keep Create a draft keep
- GET /api/v1/projects/{project}/drafts/{draft}/manifest Get draft manifest
- POST /api/v1/projects/{project}/drafts/{draft}/merge Create a draft merge
- POST /api/v1/projects/{project}/drafts/{draft}/preview Preview a draft
- PUT /api/v1/projects/{project}/drafts/{draft}/preview/access Replace preview access
- POST /api/v1/projects/{project}/drafts/{draft}/preview/invites Create a preview invite
- DELETE /api/v1/projects/{project}/drafts/{draft}/preview/invites/{invite} Delete a preview invite
- POST /api/v1/projects/{project}/drafts/{draft}/publish Publish a draft
- POST /api/v1/projects/{project}/drafts/{draft}/review Submit a draft for review
- POST /api/v1/projects/{project}/drafts/{draft}/review/decision Approve or reject a draft
- PUT /api/v1/projects/{project}/drafts/{draft}/schedule Replace a draft schedule
- POST /api/v1/projects/{project}/drafts/{draft}/sync Synchronise a draft
- GET /api/v1/projects/{project}/drafts/{draft}/validate Validate a draft
Tokens
Sessions, passkeys, step-up and API tokens.
- GET /auth/tokens List API tokens
- POST /auth/tokens Create an API token
- DELETE /auth/tokens/{id} Revoke an API token
You
The signed-in user.
- GET /api/v1/me Get the signed-in user
Templates
Starter templates for new projects.
- GET /api/v1/templates List templates
Teams
Teams (called accounts in paths): members, invitations, projects and the audit log.
- GET /api/v1/accounts/{account} Get an account
- GET /api/v1/accounts/{account}/assignments List account assignments
- GET /api/v1/accounts/{account}/audit-events List account audit events
- POST /api/v1/accounts/{account}/invitations Create an account invitation
- DELETE /api/v1/accounts/{account}/invitations/{id} Delete an account invitation
- GET /api/v1/accounts/{account}/members List account members
- PATCH /api/v1/accounts/{account}/members/{userId} Update an account member
- DELETE /api/v1/accounts/{account}/members/{userId} Delete an account member
- PUT /api/v1/accounts/{account}/members/{userId}/assignments Replace a member assignment
- GET /api/v1/accounts/{account}/projects List account projects
- POST /api/v1/accounts/{account}/projects Create an account project
- GET /api/v1/accounts/{account}/templates List account templates
- GET /api/v1/accounts/{account}/usage Get account usage
- GET /api/v1/teams List teams
This deployment
This deployment: its name and what it offers.
- GET /api/v1/hosting-providers List hosting providers
- GET /api/v1/openapi.json Get this API description
Projects
Projects, builds, deployments, domains and media.
- GET /api/v1/projects/{project} Get a project
- PATCH /api/v1/projects/{project} Update a project
- DELETE /api/v1/projects/{project} Delete a project
- GET /api/v1/projects/{project}/activity Get a project activity
- GET /api/v1/projects/{project}/analytics Get project analytics
- DELETE /api/v1/projects/{project}/analytics Delete project analytics
- POST /api/v1/projects/{project}/analytics/settings Update analytics settings
- POST /api/v1/projects/{project}/branches Create a project branche
- GET /api/v1/projects/{project}/build-env Get a project build env
- GET /api/v1/projects/{project}/builds List project builds
- POST /api/v1/projects/{project}/builds Create a project build
- POST /api/v1/projects/{project}/builds/{build}/preview-link Create a build preview link
- GET /api/v1/projects/{project}/builds/{id} Get a project build
- GET /api/v1/projects/{project}/builds/{id}/logs Get build logs
- GET /api/v1/projects/{project}/collaborators List project collaborators
- DELETE /api/v1/projects/{project}/collaborators/{userId} Delete a project collaborator
- GET /api/v1/projects/{project}/content/live/{collection} List published content in a collection
- GET /api/v1/projects/{project}/content/live/{collection}/{slug} Get a published content entry
- GET /api/v1/projects/{project}/deploy-targets List project deploy targets
- POST /api/v1/projects/{project}/deploy-targets Create a project deploy target
- PATCH /api/v1/projects/{project}/deploy-targets/{id} Update a project deploy target
- DELETE /api/v1/projects/{project}/deploy-targets/{id} Delete a project deploy target
- POST /api/v1/projects/{project}/deploy-targets/{id}/check Create a deploy target check
- GET /api/v1/projects/{project}/deployments List project deployments
- POST /api/v1/projects/{project}/deployments Create a project deployment
- POST /api/v1/projects/{project}/divergence/resolve Resolve divergence from the mirror
- GET /api/v1/projects/{project}/domains List project domains
- POST /api/v1/projects/{project}/domains Create a project domain
- DELETE /api/v1/projects/{project}/domains/{domainId} Delete a project domain
- POST /api/v1/projects/{project}/domains/{domainId}/verify Verify a domain
- GET /api/v1/projects/{project}/downloads/{key} Download an export archive
- POST /api/v1/projects/{project}/export Export a project
- GET /api/v1/projects/{project}/exports List project exports
- GET /api/v1/projects/{project}/exports/{exportId} Get a project export
- POST /api/v1/projects/{project}/form-entries/import Create a form entry import
- GET /api/v1/projects/{project}/forms List project forms
- GET /api/v1/projects/{project}/forms/{formId}/entries List form entries
- DELETE /api/v1/projects/{project}/forms/{formId}/entries/{id} Delete a form entry
- GET /api/v1/projects/{project}/forms/{formId}/entries/{id}/files/{n} Get an entry file
- GET /api/v1/projects/{project}/forms/{formId}/export Export a form
- GET /api/v1/projects/{project}/history Get project history
- GET /api/v1/projects/{project}/imports List project imports
- POST /api/v1/projects/{project}/imports Create a project import
- GET /api/v1/projects/{project}/imports/{importId} Get a project import
- GET /api/v1/projects/{project}/media List project media
- POST /api/v1/projects/{project}/media Upload project media
- DELETE /api/v1/projects/{project}/media/{assetId} Delete a media asset
- GET /api/v1/projects/{project}/media/{assetId}/raw Download a media asset
- PUT /api/v1/projects/{project}/mirror Set project mirror
- DELETE /api/v1/projects/{project}/mirror Delete project mirror
- POST /api/v1/projects/{project}/mirror/sync Synchronise a mirror
- PUT /api/v1/projects/{project}/preview-access Set project preview access
- POST /api/v1/projects/{project}/publish Publish a project
- GET /api/v1/projects/{project}/publish-manifest Get project publish manifest
- POST /api/v1/projects/{project}/publish-manifest Create project publish manifest
- GET /api/v1/projects/{project}/redirects List project redirects
- POST /api/v1/projects/{project}/redirects Create a project redirect
- DELETE /api/v1/projects/{project}/redirects/{redirectId} Delete a project redirect
- GET /api/v1/projects/{project}/repository Get project repository
- POST /api/v1/projects/{project}/rollback Roll back a project
- GET /api/v1/projects/{project}/upgrade Get a project upgrade
- POST /api/v1/projects/{project}/upgrade Create a project upgrade
- GET /api/v1/projects/{project}/webhooks List project webhooks
- POST /api/v1/projects/{project}/webhooks Create a project webhook
- PATCH /api/v1/projects/{project}/webhooks/{webhookId} Update a project webhook
- DELETE /api/v1/projects/{project}/webhooks/{webhookId} Delete a project webhook
- GET /api/v1/projects/{project}/webhooks/{webhookId}/deliveries List webhook deliveries
- POST /api/v1/projects/{project}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver Create a delivery redeliver
- POST /api/v1/projects/{project}/webhooks/{webhookId}/rotate-secret Create a webhook rotate secret
- POST /api/v1/projects/{project}/webhooks/{webhookId}/test Create a webhook test
- GET /api/v1/webhook-events List webhook events