Skip to content
Buzz
Search
Ctrl
K
Cancel
Star us on GitHub
Getting Started
Deploy Your First Site
Guides
Deploy Sites
Choose A Site Name
Serve Clean URLs
Deploy A Single-Page App
Automate Deployments
Make A Site Private
Understand Analytics
Connect a Custom Domain
Self-Hosting
Self-Hosting Overview
Security
Configure DNS And TLS
Configure GitHub Authentication
Deploy With Docker Compose
Deploy With Coolify
Configure Deployment Limits
Manage Data And Backups
Troubleshooting
Troubleshoot Deployment
Troubleshoot Self-Hosting
Reference
CLI
Configuration
Hosting Behavior
HTTP API
Overview
Authentication
Overview
Start device authorization
Poll device authorization
Revoke the current session
Get the signed-in user
Sites
Overview
Deploy a site
List owned sites
Delete a site
List site deployments
Activate a site deployment
Custom Domains
Overview
Check custom-domain capability
List custom domain claims
Create a custom domain claim
Cancel a custom domain claim
Check custom domain ownership
Cancel a custom domain transition
Retry a custom domain transition
Deployment Tokens
Overview
List deployment tokens
Create a deployment token
Revoke a deployment token
Access
Overview
Get site visibility
Make a site private
Make a site public
Resolve a GitHub user for private-site access
List private-site readers
Add a private-site reader
Remove a private-site reader
System
Overview
Check server health
Report the server version
Contributing
Development
Documentation
Releases
Star us on GitHub
Overview
Access
Section titled “Access”
Private-site protection and reader access.
Operations
Section titled “Operations”
GET
/sites/{site_name}/access
PUT
/sites/{site_name}/access
DELETE
/sites/{site_name}/access
GET
/sites/{site_name}/access/github-users/{github_login}
GET
/sites/{site_name}/access/readers
POST
/sites/{site_name}/access/readers
DELETE
/sites/{site_name}/access/readers/{reader_id}