Skip to main content

API Documentation

Pulsarr provides a REST API for integrating with external applications and services. The API is documented using the OpenAPI 3.0 specification.

Docusaurus API Reference (This Site)​

This documentation site includes interactive API documentation with auto-generated pages for every endpoint:

View Complete API Reference →

API Categories​

The API is organized into the following categories:

  • API Keys - Create and manage API keys for programmatic access
  • Approval - Manage content approval requests and workflows
  • Authentication - Login, logout, and session management
  • Config - Application settings and configuration
  • Content Router - Routing rules and content distribution
  • Labels - Plex label synchronization and management
  • Logs - Stream application logs
  • Metadata - Refresh and manage content metadata
  • Notifications - Discord bot and webhook management
  • Plex - User management, watchlist synchronization, server discovery
  • Progress - Real-time workflow progress tracking
  • Quota - User quota management and usage tracking
  • Radarr - Instance configuration and movie management
  • Scheduler - Job scheduling and execution
  • Session Monitoring - Plex session tracking
  • Sonarr - Instance configuration and series management
  • Statistics - Dashboard statistics and analytics
  • Sync - Sync operations for Sonarr/Radarr instances
  • Tags - User tagging configuration and synchronization
  • TMDB - TMDB metadata and streaming provider data
  • Users - User management and watchlist access
  • Watchlist Workflow - Start, stop, and monitor the main workflow

Benefits:

  • Organized by feature category
  • Detailed descriptions and examples
  • Great for browsing and learning the API
  • No authentication required to view

Scalar API Docs (Your Instance)​

Every Pulsarr instance also ships with Scalar interactive documentation at /api/docs:

http://your-server:3003/api/docs

Benefits:

  • Live testing against YOUR instance - Execute real API requests
  • Uses your session - If you're logged into the web UI, requests use your session token
  • Always in sync - Reflects your exact running version
  • OpenAPI spec download - Download JSON/YAML from the Scalar interface

Use Scalar when:

  • You need to test API calls against your running instance
  • You want to verify authentication and permissions
  • You're debugging API integration issues

Getting Started​

Base URL​

All API endpoints use the following base URL:

http://your-server:3003/v1

Authentication​

Most endpoints require authentication. You can authenticate using:

  • Session cookies (web UI login)
  • API keys (recommended for external integrations)

To create an API key, navigate to Utilities → API Keys in the web UI.