Skip to content
Blockbusterr v2

API Overview

Blockbusterr provides a comprehensive RESTful API for managing jobs, viewing activity, and previewing content.

Base URL

Section titled “Base URL”
http://localhost:9090/v1

Replace localhost:9090 with your Blockbusterr instance URL.

Response Format

Section titled “Response Format”

All endpoints return JSON unless otherwise specified.

Success Response:

{
  "data": { ... },
  "count": 10
}

Error Response:

{
  "error": "Error message here"
}

Status Codes

Section titled “Status Codes”
CodeMeaning
200Success
400Bad Request - Invalid parameters
404Not Found - Resource doesn’t exist
409Conflict - Stale revision or resource still in use
500Internal Server Error

Authentication

Section titled “Authentication”

When BLOCKBUSTERR_AUTH_TOKEN is configured, the UI and API use HTTP Basic authentication. Use username blockbusterr and the configured token. Without a token, access is unrestricted and the instance must remain on a trusted network.

Rate Limiting

Section titled “Rate Limiting”

The HTTP API does not impose request rate limiting. Delivery budgets configured for jobs still apply to successful automated additions and requests.

API Sections

Section titled “API Sections”

Jobs API

Section titled “Jobs API”

Manage and trigger jobs, preview content before adding.

  • Preview jobs
  • Trigger jobs manually
  • Get job status

Activity API

Section titled “Activity API”

View and manage Activity Entries and Job Runs.

  • Query title-level Activity Entries
  • Inspect aggregate Job Runs
  • Get activity statistics
  • Clear old logs

Rules API

Section titled “Rules API”

Manage reusable movie/show rules and universal title exceptions.

  • Create and revise rule sets
  • Inspect assignment counts
  • Create job-specific rule copies

Configuration API

Section titled “Configuration API”

Manage integrations and test connections.

  • Validate Radarr/Sonarr connections
  • Get quality profiles and root folders
  • Fetch metadata (genres, countries, languages)

Quick Examples

Section titled “Quick Examples”

Preview a Job

Section titled “Preview a Job”
Terminal window
curl -X POST http://localhost:9090/v1/jobs/preview/trending-movies

Trigger a Job

Section titled “Trigger a Job”
Terminal window
curl -X POST http://localhost:9090/v1/jobs/trigger/popular-shows

Get Recent Activity

Section titled “Get Recent Activity”
Terminal window
curl "http://localhost:9090/v1/activity/logs?limit=50"
Section titled “Get Trending Movies from Trakt”
Terminal window
curl "http://localhost:9090/v1/trakt/trending/movies?limit=10"

Next Steps

Section titled “Next Steps”