REST API Reference
The Zerops REST API allows you to programmatically interact with Zerops platform by providing access to resources like projects, services, users, billing, and configurations.
Base URL
All API requests should be made to:
Authentication
The API uses Bearer token authentication. You can obtain your Personal access token from the Access Token management section in the Zerops GUI.
Include the token in the Authorization header:
API Resources
Note
Some resource groups have non-obvious naming:
/service-stack
endpoints handle services management/user-data
endpoints handle environment variables management
View the full Swagger documentation or jump to a specific resource group:
Group | Description |
---|---|
/app-version | Manage application versions, builds, and deployments |
/auth | Authentication and token management |
/billing | Billing operations and payment management |
/client | Client account management |
/client-user | User management within client accounts |
/github | GitHub repository connections and authorization |
/gitlab | GitLab repository connections and authorization |
/project | Project management operations |
/project-env | Project environment variables management |
/public-http-routing | HTTP routing configuration |
/public-port-routing | Port routing and firewall rules configuration |
/service-stack | Service stack operations and configuration |
/settings | System settings and configurations |
/user | User account management |
/user-data | Environment variables management |
/user-notification | User notifications management |
/user-token | Personal access tokens management |