API Reference
Polaris API — v2.0.0
Overview
Polaris Technology Catalog API
The Polaris API provides programmatic access to the technology catalog, enabling automation, integration, and custom tooling.
Key Features
- RESTful Design - Resource-based URLs with proper HTTP methods
Authentication
Most endpoints require authentication using session-based authentication integrated with the web application.
Authorization Levels:
Response Format
All successful responses follow this structure:
`json
{
"success": true,
"data": [...],
"count": 10
}
`All errors follow this structure:
`json
{
"statusCode": 404,
"message": "Resource 'example' not found"
}
`
Richardson Maturity Model
This API implements RMM Level 2 with proper use of HTTP methods and status codes.
Health
Health check endpoints
Systems
System management endpoints
Components
Component management endpoints
Technologies
Technology catalog endpoints
Teams
Team management endpoints
Version Constraints
Version constraint endpoints
Compliance
Compliance violation and audit endpoints
Repositories
Repository management endpoints
Users
User management endpoints
Approvals
Technology approval endpoints
Admin
Administrative endpoints