# Layerbeat - [Layerbeat documentation](/): Deploy and manage cloud machines from the console, the CLI or your application. - Guides - **Get started** - [Deploy your first VPS](/guides/quickstart): A practical path from a verified account to a running cloud machine. - [Set up your account](/guides/account): Register, verify your email and finish onboarding before adding credit. - [Authentication and API keys](/guides/authentication): Authenticate requests and give each integration only the permissions it needs. - [Workspaces and roles](/guides/organizations-and-roles): Share servers with your team while keeping each person's credit and payments private. - **VPS** - [Locations, images and plans](/guides/catalog): Choose a compatible configuration and review its current regional price. - [Pricing](/guides/pricing): How server and disk prices work, and where agents read the live price list. - [Create and manage a VPS](/guides/servers): Purchase a prepaid machine, follow provisioning and manage its lifecycle. - [Windows servers](/guides/windows): Run Windows Server with the licence included and connect over Remote Desktop. - [SSH keys and passwords](/guides/secure-access): Choose how to log in and retrieve a generated password securely. - [Networking and firewall](/guides/networking): Use your public IP and allow only the ports your application needs. - [Metrics and transfer](/guides/metrics): Inspect 24-hour performance data and manage who can read it. - [Renewals and expiry](/guides/renewals): Extend a subscription, set automatic renewal limits and understand the grace period. - [Disks](/guides/disks): Add storage that keeps its data when a server ends, and move it between servers. - **Billing** - [Credit and billing](/guides/money): Understand personal balances, prepaid purchases and payment confirmation. - [Pay with USDC](/guides/top-up-layerbeat-credit-with-usdc): Fund personal USD credit using the exact stablecoin instructions for your top-up. - [Pay in Rupiah with Doit](/guides/top-up-with-doit-idr): Add exact IDR credit using QRIS, a virtual account or hosted checkout. - **Build with the API** - [Build for AI agents](/guides/agents): Give an agent bounded server access and a reliable credit-funding workflow. - [Agent payments](/guides/agent-payments): Let an AI agent add Layerbeat credit itself over HTTP 402, with x402 on Solana (pay.sh) or MPP on Tempo, from the CLI, MCP or its own code. - [Track asynchronous operations](/guides/asynchronous-operations): Follow purchases, renewals and server actions until their result is confirmed. - [Safe retries with idempotency](/guides/idempotency): Recover a timed-out request without buying another server or creating another checkout. - [Pagination and filters](/guides/pagination): Read growing lists with cursors and endpoint-specific filters. - [Rate limits](/guides/rate-limits): Read your request budget and back off when the API returns 429. - [Errors and troubleshooting](/guides/errors): Interpret API failures and recover without duplicating a payment or order. - [Audit history](/guides/audit-trail): Review workspace security events separately from personal payment history. - **Grow with Layerbeat** - [Refer & Earn](/guides/referrals): Share an invite code, review eligible rewards and apply for the partner program. - Command-line tool - [Command-line tool](/cli): Buy, run and pay for Layerbeat servers from your terminal, your scripts or your coding agent. - [Install and update](/cli/install): Install the layerbeat CLI on macOS or Linux, keep it up to date, or remove it. - [Sign in](/cli/sign-in): Sign in through your browser, use API keys for scripts and agents, and choose a workspace. - [Servers](/cli/servers): Choose, price, buy and manage servers from the command line. - [SSH, exec and copy](/cli/ssh): Log in to a server, run commands and copy files, with the server's SSH host key pinned. - [Disks and firewall](/cli/disks-and-firewall): Add storage that moves between servers, and open or close ports, from the command line. - [Templates](/cli/templates): Install ready-made software on a running server without SSH, from the command line. - [Credit](/cli/credit): Check your balance, add credit and see your history from the command line. - [Agents and MCP](/cli/agents): Let Claude Code, Codex, Cursor, opencode or any MCP client manage Layerbeat as tools. - [Scripting](/cli/scripting): JSON output, exit codes, waiting and safe retries for scripts, CI and agents. - [Command reference](/cli/reference): Every layerbeat command, grouped by what it does. - API reference - Catalog - [List images](/api/catalog/listImages) - [List plans with prices](/api/catalog/listPlans) - [List regions](/api/catalog/listRegions) - Account - [Approve a command-line sign-in](/api/account/authorizeCliLogin) - [Sign in (browser session)](/api/account/browserLogin) - [Create an account (browser session)](/api/account/browserSignup) - [Finish account setup](/api/account/completeAccountOnboarding) - [Confirm email ownership](/api/account/confirmEmailVerification) - [Recover account password](/api/account/confirmPasswordRecovery) - [Create an API key](/api/account/createApiKey) - [Disconnect a sign-in provider](/api/account/disconnectSocialAccount) - [Exchange a legacy browser session](/api/account/exchangeBrowserSession) - [Finish a command-line sign-in](/api/account/exchangeCliLogin) - [Finish provider authorization](/api/account/finishSocialSignIn) - [Get account setup status](/api/account/getAccountOnboarding) - [Read your workspace email preferences](/api/account/getEmailPreferences) - [Who am I](/api/account/getMe) - [Get personal billing currency](/api/account/getPersonalPreferences) - [Get browser security-check configuration](/api/account/getTurnstileConfiguration) - [List API keys](/api/account/listApiKeys) - [List your recent email delivery status](/api/account/listEmailHistory) - [List your sessions](/api/account/listSessions) - [List your connected sign-in accounts](/api/account/listSocialConnections) - [List social sign-in availability](/api/account/listSocialProviders) - [Sign in](/api/account/login) - [Sign out](/api/account/logout) - [Request email verification](/api/account/requestEmailVerification) - [Request password recovery](/api/account/requestPasswordRecovery) - [Revoke an API key](/api/account/revokeApiKey) - [Sign out a session](/api/account/revokeSession) - [Save your workspace email preferences](/api/account/saveEmailPreferences) - [Create an account](/api/account/signup) - [Start social sign-in or connect a provider](/api/account/startSocialSignIn) - [Save personal billing currency](/api/account/updatePersonalPreferences) - Organization - [Add a member](/api/organization/addMember) - [Get the active organization](/api/organization/getOrg) - [Read the audit log](/api/organization/listAuditLog) - [List members](/api/organization/listMembers) - [Remove a member or leave](/api/organization/removeMember) - [Change a member's role](/api/organization/updateMember) - Servers - [Price a server](/api/servers/createQuote) - [Buy a server](/api/servers/createVm) - [Delete a server](/api/servers/deleteVm) - [Forget the saved initial server password](/api/servers/forgetServerPassword) - [Get server metric access grants](/api/servers/getServerMetricAccess) - [Get server performance metrics](/api/servers/getServerMetrics) - [Get server traffic usage](/api/servers/getServerTraffic) - [Get a server](/api/servers/getVm) - [Read server renewal settings and prices](/api/servers/getVmRenewal) - [List servers](/api/servers/listVms) - [Open a browser console](/api/servers/openConsole) - [Reboot a running server](/api/servers/rebootVm) - [Renew a server subscription](/api/servers/renewVm) - [Replace server metric access grants](/api/servers/replaceServerMetricAccess) - [Reveal the initial generated server password](/api/servers/revealServerPassword) - [Set opt-in automatic renewal](/api/servers/setVmRenewal) - [Start a stopped server](/api/servers/startVm) - [Stop a running server](/api/servers/stopVm) - Network - [Add a firewall rule](/api/network/addFirewallRule) - [Delete a firewall rule](/api/network/deleteFirewallRule) - [List firewall rules](/api/network/listFirewallRules) - SSH keys - [Add an SSH public key](/api/ssh-keys/addSshKey) - [Delete an SSH key](/api/ssh-keys/deleteSshKey) - [List SSH keys](/api/ssh-keys/listSshKeys) - Disks - [Attach a disk to a server](/api/disks/attachVolume) - [Buy a disk](/api/disks/createVolume) - [Delete a disk](/api/disks/deleteVolume) - [Detach a disk from its server](/api/disks/detachVolume) - [Get a disk](/api/disks/getVolume) - [Disk options for a region](/api/disks/getVolumeOptions) - [List disk prices](/api/disks/listDiskPrices) - [List system disks](/api/disks/listSystemDisks) - [List disks](/api/disks/listVolumes) - [Renew a disk](/api/disks/renewVolume) - [Rename a disk](/api/disks/updateVolume) - Templates - [Check a deployment](/api/templates/checkDeployment) - [Deploy a template](/api/templates/createDeployment) - [Get a deployment](/api/templates/getDeployment) - [Get a deployment's script](/api/templates/getDeploymentScript) - [Get a template](/api/templates/getTemplate) - [List deployments](/api/templates/listDeployments) - [List templates](/api/templates/listTemplates) - [Preview a template's script](/api/templates/previewTemplateScript) - [Remove a deployment](/api/templates/removeDeployment) - [Update or retry a deployment](/api/templates/updateDeployment) - Operations - [Get an operation](/api/operations/getOperation) - Billing - [Top up personal credit](/api/billing/createTopUp) - [Get a payment](/api/billing/getPayment) - [Get the wallet](/api/billing/getWallet) - [List payment methods](/api/billing/listPaymentMethods) - [List payments](/api/billing/listPayments) - [List wallet transactions](/api/billing/listTransactions) - [Use the payment network for a connected wallet](/api/billing/paymentSolanaRpc) - [Receive a signed Doit payment notification](/api/billing/receiveDoitNotification) - [Verify or recover a hosted IDR payment](/api/billing/refreshPayment) - [Pay an agent credit top-up with MPP on Tempo](/api/billing/topUpMpp) - [Pay an agent credit top-up with x402](/api/billing/topUpX402) - Affiliates - [Activate customer referrals](/api/affiliates/activateAffiliate) - [Apply to become an affiliate partner](/api/affiliates/applyAffiliatePartner) - [Cancel a payout request](/api/affiliates/cancelAffiliatePayout) - [Capture a referral visit](/api/affiliates/captureReferralVisit) - [Convert earnings into Layerbeat credit](/api/affiliates/convertAffiliateEarnings) - [Read affiliate dashboard](/api/affiliates/getAffiliateDashboard) - [Read browser referral attribution](/api/affiliates/getReferralAttribution) - [List payout requests](/api/affiliates/listAffiliatePayouts) - [List private referrals](/api/affiliates/listAffiliateReferrals) - [List purchase rewards](/api/affiliates/listAffiliateRewards) - [Read the earnings statement](/api/affiliates/listAffiliateStatement) - [Reserve earnings for payout review](/api/affiliates/requestAffiliatePayout) - Platform - [Liveness check](/api/platform/getHealth) - [Readiness check](/api/platform/getReady) - [Receive a signed email-provider delivery event](/api/platform/receiveEmailDeliveryEvent)