API Reference¶
This page provides a comprehensive overview of the OrbitRepos API surface. The API is divided into three main categories: Public, Management, and Format-specific endpoints.
Detailed Documentation Coming Soon
Detailed API documentation (OpenAPI/Swagger) is currently under development. For a full technical map of all available routes and their handlers, please refer to the Architecture Documentation.
1. Public Endpoints¶
Public endpoints are accessible without authentication. They are primarily used for system health checks, status monitoring, and the initial authentication flow.
- Health Checks: Basic
/healthendpoint for load balancers. - System Status: Detailed system status at
/api/v1/status. - Metrics: Prometheus-compatible metrics available at
/metrics. - Authentication: Login and OIDC callback routes.
Detailed public API documentation coming soon.
2. Management API¶
The Management API requires authentication (JWT or API Token) and is used for all administrative and user-facing repository management tasks.
Repository Management¶
- List/Search: Retrieve all configured repositories.
- CRUD Operations: Create, Read, Update, and Delete repository configurations.
- Statistics: Per-repository usage and storage statistics.
User & Security Management¶
- User Profiles: Manage local users and view current session info.
- RBAC: Role and Group management for fine-grained access control.
- API Tokens: Generation and revocation of long-lived access tokens.
System Settings¶
- Auth Configuration: Manage LDAP and OIDC provider settings.
- Audit Logs: Access system-wide audit trails for security monitoring.
- Cleanup Policies: Configure and trigger artifact retention policies.
Detailed management API documentation coming soon.
3. Format-Specific APIs¶
These APIs implement the protocol-specific endpoints for various package managers and container registries. Most format APIs use RBAC for authorization.
| Format | Base Path | Protocol Support |
|---|---|---|
| Docker | /v2/ |
OCI / Docker Registry v2 |
| Maven | /maven/ |
Maven 2 repository layout |
| npm | /npm/ |
npm registry API |
| PyPI | /pypi/ |
Python Simple Repository API |
| NuGet | /nuget/ |
NuGet V2/V3 protocols |
| Go | /go/ |
Go Module proxy protocol |
| Helm | /helm/ |
Helm chart repository API |
| APT | /apt/ |
Debian package repository layout |
| Raw | /raw/ |
Generic file upload/download |
Detailed format API documentation coming soon.