For detailed request/response schemas and to test API calls, visit the full Swagger documentation.
Resource Groups
Authentication & Users
Manage authentication, user accounts, and access tokens./auth
Authentication and token management
/user
User account management
/user-token
Personal access tokens management
/user-notification
User notifications management
Projects & Services
Manage your projects and services./project
Project management operations
/service-stack
Service stack operations and configuration
/app-version
Manage application versions, builds, and deployments
Configuration & Environment
Manage environment variables and configurations./user-data
Environment variables management
/project-env
Project environment variables management
/settings
System settings and configurations
Networking & Routing
Configure HTTP routing, port routing, and firewall rules./public-http-routing
HTTP routing configuration
/public-port-routing
Port routing and firewall rules configuration
Organization & Access
Manage client accounts and user access./client
Client account management
/client-user
User management within client accounts
Billing
Manage billing operations and payments./billing
Billing operations and payment management
Version Control Integration
Connect and manage GitHub and GitLab repositories./github
GitHub repository connections and authorization
/gitlab
GitLab repository connections and authorization
Common Operations
Here are some common API operations you might need:List Projects
Retrieve all projects you have access to:Get Project Details
Get detailed information about a specific project:List Services
List all services in a project:Manage Environment Variables
Get environment variables for a service:Response Codes
The API uses standard HTTP response codes:The request was successful
A new resource was successfully created
The request was invalid or cannot be served
Authentication failed or token is missing
The authenticated user doesn’t have permission
The requested resource doesn’t exist
Rate limit exceeded
An error occurred on the server
Interactive Documentation
For interactive API documentation with detailed request/response schemas and the ability to test endpoints:Swagger Documentation
Explore the complete API reference with interactive examples
Need Help?
If you need assistance with the API:- Check the Authentication guide for auth issues
- Review the Swagger documentation for detailed schemas
- Consider using the Zerops CLI as an alternative to the API