REST API reference
REST API of the OpenArtifact artifact repository manager.
This reference is generated from the embedded OpenAPI document internal/api/openapi.json and lists 287 endpoints in 28 tags. Authentication, token kinds, CSRF handling and worked examples are in the REST API guide.
Security
Unless an endpoint says otherwise, a request must satisfy one of: bearerAuth or cookieAuth.
| Scheme | Type | Details | Description |
|---|---|---|---|
bearerAuth | http | scheme bearer | Bearer token authentication |
cookieAuth | apiKey | oa_session in cookie | Session cookie set by POST /api/v1/auth/login. State-changing requests (POST, PUT, PATCH, DELETE) must also send the value of the readable oa_csrf cookie in the X-CSRF-Token header. |
Servers
/: Current server
Endpoints by tag
| Tag | Endpoints | Description |
|---|---|---|
| Admin | 50 | - |
| AI | 7 | - |
| Audit | 2 | - |
| Authentication | 8 | - |
| Backup | 5 | - |
| Branding | 7 | - |
| Bundles | 18 | - |
| Cleanup | 8 | - |
| Declarative | 3 | - |
| Dependency-Track | 9 | - |
| Documentation | 3 | - |
| Federation | 9 | - |
| GPG | 7 | - |
| Groups | 10 | - |
| Packages | 12 | - |
| Permissions | 8 | - |
| Projects | 30 | - |
| Repositories | 66 | - |
| SBOM | 15 | - |
| Scanning | 32 | - |
| Search | 1 | - |
| SSO | 13 | - |
| Storage | 25 | - |
| System | 5 | - |
| Tokens | 9 | - |
| Trash | 6 | - |
| Users | 9 | - |
| Webhooks | 9 | - |
Schemas
All 150 named request and response objects are on the schemas page.