Skip to main content
Skip to main content
🚧 Work in Progress

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:

https://api.app-prg1.zerops.io/api/rest/public

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:

Authorization: Bearer <your-token>

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:

GroupDescription
/app-versionManage application versions, builds, and deployments
/authAuthentication and token management
/billingBilling operations and payment management
/clientClient account management
/client-userUser management within client accounts
/githubGitHub repository connections and authorization
/gitlabGitLab repository connections and authorization
/projectProject management operations
/project-envProject environment variables management
/public-http-routingHTTP routing configuration
/public-port-routingPort routing and firewall rules configuration
/service-stackService stack operations and configuration
/settingsSystem settings and configurations
/userUser account management
/user-dataEnvironment variables management
/user-notificationUser notifications management
/user-tokenPersonal access tokens management