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

  • Comprehensive Coverage - Systems, Teams, Technologies, Components, Policies, and more
  • Developer-Friendly - Clear error messages and consistent response structure

    Authentication

    Most endpoints require authentication using session-based authentication integrated with the web application.

    Authorization Levels:

  • Public - No authentication required
  • Authenticated - Valid user session required
  • Team Member - User must belong to a team
  • Team Owner - User must belong to team that owns the resource
  • Superuser - User must have superuser role

    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