> ## Documentation Index
> Fetch the complete documentation index at: https://docs.binarly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# On-Prem API Considerations

> API specifics for On-Premise deployments

On-Premise deployments run the Binarly Transparency Platform within your own infrastructure, providing complete control over data and connectivity.

## Base URLs

Your base URLs are determined by your installation configuration:

| Service                   | URL Pattern                                        |
| ------------------------- | -------------------------------------------------- |
| API Server                | `https://<YOUR_DASHBOARD_DOMAIN>/api/v4`           |
| Authentication (Keycloak) | `https://<YOUR_KEYCLOAK_HOST>/realms/BinarlyRealm` |
| Dashboard                 | `https://<YOUR_DASHBOARD_DOMAIN>`                  |

> Consult your infrastructure team or installation documentation for exact URLs.

## Authentication

On-Prem uses **Keycloak** as the identity provider. The setup process is identical to SaaS:

* **M2M (CI/CD)**: [Setup API Client](/api-reference/authentication/create-api-client) – Keycloak Admin Console access required
* **User Access**: [User Authentication](/api-reference/authentication/generate-token)

### Keycloak Admin Access

For On-Prem installations, you have full access to the Keycloak Admin Console to:

* Create and manage API Clients
* Configure user federation (LDAP, SAML)
* Customize authentication policies

See the [On-Prem Installation Guide](/on-prem/v3/configuration) for Keycloak configuration details.

## Network Considerations

### Internal Access

Ensure your CI/CD runners can reach:

* API Server (port 443)
* Keycloak (port 443)

### Air-Gapped Environments

For fully air-gapped deployments:

* Pre-download required container images
* Configure local image registries
* See [On-Prem Installation](/on-prem/v3/installation) for offline setup

## Differences from SaaS

| Feature         | SaaS           | On-Prem               |
| --------------- | -------------- | --------------------- |
| Updates         | Automatic      | Manual (Helm upgrade) |
| Keycloak Access | Limited        | Full Admin            |
| Data Location   | Binarly Cloud  | Your Infrastructure   |
| Custom Rules    | Cloud Registry | Requires Harbor       |

## Related Documentation

* [On-Prem v3 Installation](/on-prem/v3/installation)
* [On-Prem v3 Configuration](/on-prem/v3/configuration)
* [SaaS vs On-Prem Overview](/user-guides/about/deployment-architectures/SaaS-vs-onprem)