# 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](https://api.app-prg1.zerops.io/api/rest/public/swagger) or jump to a specific resource group:

<table className="w-full">
  <thead className="rounded-lg">
    <tr>
      <th className="w-auto"><strong>Group</strong></th>
      <th className="w-full"><strong>Description</strong></th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/app-version](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicAppVersion)</strong></td>
      <td className="w-fit">Manage application versions, builds, and deployments</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/auth](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicAuth)</strong></td>
      <td className="w-fit">Authentication and token management</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/billing](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicBilling)</strong></td>
      <td className="w-fit">Billing operations and payment management</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/client](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicClient)</strong></td>
      <td className="w-fit">Client account management</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/client-user](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicClientUser)</strong></td>
      <td className="w-fit">User management within client accounts</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/github](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicGithub)</strong></td>
      <td className="w-fit">GitHub repository connections and authorization</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/gitlab](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicGitlab)</strong></td>
      <td className="w-fit">GitLab repository connections and authorization</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/project](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicProject)</strong></td>
      <td className="w-fit">Project management operations</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/project-env](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicProjectEnv)</strong></td>
      <td className="w-fit">Project environment variables management</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/public-http-routing](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicPublicHttpRouting)</strong></td>
      <td className="w-fit">HTTP routing configuration</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/public-port-routing](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicPublicPortRouting)</strong></td>
      <td className="w-fit">Port routing and firewall rules configuration</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/service-stack](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicServiceStack)</strong></td>
      <td className="w-fit">Service stack operations and configuration</td>
    </tr>
    <tr>
      <td className="w-fit"><strong>[/settings](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicSettings)</strong></td>
      <td className="w-fit">System settings and configurations</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/user](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicUser)</strong></td>
      <td className="w-fit">User account management</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/user-data](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicUserData)</strong></td>
      <td className="w-fit">Environment variables management</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/user-notification](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicUserNotification)</strong></td>
      <td className="w-fit">User notifications management</td>
    </tr>
    <tr>
      <td className="w-fit whitespace-nowrap"><strong>[/user-token](https://api.app-prg1.zerops.io/api/rest/public/swagger/#/PublicUserToken)</strong></td>
      <td className="w-fit">Personal access tokens management</td>
    </tr>
  </tbody>
</table>