FRbext.dev
DocsCloud
On this page

bext Cloud

bext Cloud is the control plane for your sites and projects. Use the dashboard, the authenticated API, or a compatible MCP client to work with the same account and its permissions.

Choose a task#

I want to… Start here
Create a WordPress, PrestaShop or PRISM site Sites and deployments
Deploy a configured Git project Deploy from a repository
Publish on my own domain Connect a domain
Create or download a backup Backups
Let an assistant manage my sites Cloud MCP server
Operate the platform as an administrator Admin panel

Start from the dashboard#

  1. Sign in to Cloud.
  2. Open New project and choose the kind of site or project you need.
  3. Open its project page to follow provisioning or deployment, attach domains, and inspect the available tools.

A managed site and a Git project have different lifecycles. A managed PRISM starter is provisioned directly; it is not a repository deployment. Use a separate Git project when you need builds from a repository.

The free plan includes one managed staging site. Additional managed sites and publication on your own domain require an eligible paid plan. The daily-backup option is separate. Cloud enforces your account's subscription, site allowance and ownership checks for dashboard, API and MCP operations alike.

Use account tokens#

For the CLI, run:

bash
bext login

Complete the browser sign-in. The CLI stores its account credentials in ~/.bext/credentials.json.

For an assistant or your own integration, create a named token from Account → Connect an assistant. The account page provides a 90-day token and MCP connection configuration. Tokens are displayed once; revoke them from the account's token list when they are no longer needed.

An account token has the account's permissions, including administrative access if the account is an administrator. Keep it out of public repositories, screenshots and shared logs.

Call the API#

Set BEXT_CLOUD_TOKEN in your shell or secret store, then verify the account:

bash
curl https://cloud.bext.dev/api/auth/whoami \
  -H "Authorization: Bearer $BEXT_CLOUD_TOKEN"

List its projects:

bash
curl https://cloud.bext.dev/api/projects \
  -H "Authorization: Bearer $BEXT_CLOUD_TOKEN"

Project IDs from this response are used by the deployment, domain, log and backup APIs. A project name is not a substitute for its ID; managed site lifecycle operations use a site slug.

Endpoint Method Purpose
/api/projects GET / POST List or create projects
/api/projects/:projectId GET / PUT Read or update a project
/api/sites GET / POST List or provision managed sites
/api/projects/:projectId/deploys GET / POST Read deployment history or request a deployment
/api/projects/:projectId/domains GET / POST Read domains or attach one for verification
/api/projects/:projectId/logs GET Read recent logs
/api/backups?project_id=:projectId GET Read backup history
/api/backups POST Request a backup
/api/auth/tokens GET / POST List or create account tokens
/api/auth/tokens/:tokenId DELETE Revoke an account token
/api/mcp POST Call the Cloud MCP server

API errors contain an error message and may include a machine-readable code. Treat a returned job or deployment as acceptance, then follow its status. A request that has started a build has not yet verified that the deployed site works.

Organize client work#

Agency accounts can organize projects by client and use the dashboard's client views. Platform administration, server imports and infrastructure actions have additional access requirements; they are not granted by creating a project or connecting an MCP client.

For an existing nginx server, read the migration guide before importing or changing its configuration. For an application running outside Cloud, see deployment modes.

More API endpoints#

These existing project and agency endpoints complement the task guides. Each operation still checks the caller's permissions; a listed endpoint is not a guarantee that an operation is available for every project or provider.

Endpoint Methods Purpose
/api/projects/:projectId/domains/:domainId PATCH / DELETE Verify or remove an attached domain
/api/projects/:projectId/php-pool GET Inspect the project's PHP pool
/api/projects/:projectId/ssl GET Inspect certificates
/api/projects/:projectId/metrics GET Read project metrics
/api/projects/:projectId/members GET / POST List or add project members
/api/projects/:projectId/deploys/:deploymentId/rollback POST Request a supported rollback
/api/projects/:projectId/deploys/:deploymentId/cancel POST Cancel an in-progress deployment record
/api/projects/:projectId/webhook GET / POST Read or configure the GitHub webhook
/api/agency GET / POST Read or create an agency
/api/agency/clients GET / POST List or create client records
/api/agency/clients/:clientId GET / PUT / DELETE Read, update or remove a client record

Billing and role management remain in their dashboard views. See subscription and billing for your plan and the admin reference for platform-only access.

Server imports and platform administration have additional permissions. Read the nginx migration guide and admin reference before using those workflows.

Server health monitoring#

The Cloud dashboard also reads information from connected bext instances. On the engine host, /__bext/health reports basic engine health; the other management and diagnostics endpoints have their own access requirements. See endpoints and credentials before connecting an instance, and monitoring for health and metrics.

Edit this page ↗Need a hand? ↗
Search documentation

Start with a topic, a command, or a question.