Jackett is a powerful tool that acts as a proxy server, allowing users to access various indexers and retrieve torrent results in a standardized format. If you want to integrate Jackett with applications like Sonarr, Radarr, or Prowlarr, you’ll need an API key. This API key grants these applications permission to communicate with Jackett and fetch results from configured indexers.
Getting a Jackett API key is quick and simple. In this guide, we’ll walk you through the process step by step and provide helpful insights along the way.
What is Jackett and Why Do You Need an API Key?
Jackett is essentially a middleman between your media management applications and various torrent or Usenet indexers. It converts different site formats into a unified structure that Sonarr, Radarr, or similar software can understand.
The API key is crucial because it acts as a secure method for external applications to communicate with Jackett without requiring constant manual intervention. Instead of manually searching multiple indexers, your media application can automatically fetch results through Jackett using this key.
How to Get Your Jackett API Key
To retrieve your Jackett API key, follow these steps:
- Open Jackett: Ensure that Jackett is installed and running on your system. You can access it via your web browser by navigating to http://127.0.0.1:9117 if it’s running locally.
- Log in (if required): If you’ve set up a username and password for Jackett, enter your credentials to access the dashboard.
- Go to the Dashboard: Once inside Jackett, navigate to the main interface where your configured indexers are listed.
- Locate the API Key: Scroll to the top of the page and look for a section labeled API Key. It is usually a long alphanumeric string.
- Copy the API Key: Click on the API key field and copy it. Store it somewhere safe, as you’ll need it to integrate Jackett with other applications.
How to Use the Jackett API Key
Once you have your API key, you can integrate Jackett with various applications. Here’s how:
Adding the API Key to Sonarr or Radarr
- Open Sonarr or Radarr and navigate to the settings.
- Select the Indexers tab and click on Add Indexer.
- Choose Torznab as the indexer type.
- Enter the correct URL, usually in this format:
http://127.0.0.1:9117/api/v2.0/indexers/{indexerName}/results/torznab. - Paste your copied API key into the appropriate field.
- Save the settings and test the connection to ensure it’s working correctly.
Common Issues and Troubleshooting
Sometimes, users run into problems when using their Jackett API key. Here are a few common issues and how to resolve them:
1. Incorrect Jackett API Key
If your setup isn’t working, double-check that you’ve copied the correct API key. Even a missing or extra character can result in errors.
2. Jackett Isn’t Running
Ensure that Jackett is running. If the service is stopped, Sonarr or Radarr won’t be able to connect to it.
3. Wrong URL Format
The API request URL should include the correct indexer name and API key. Double-check for any typos in the URL.
4. Firewall or Port Issues
If you’re running Jackett on a different machine, make sure your firewall settings allow traffic through port 9117.
Conclusion
Acquiring and using a Jackett API key is a straightforward process that significantly enhances your media automation experience. By integrating Jackett with tools like Sonarr or Radarr, you can automate the search and retrieval of torrents, making media management effortless.
If you encounter any issues, troubleshooting steps like verifying your API key, checking URL formats, or ensuring Jackett is running can help resolve the problem.
With the Jackett API key set up, you’re now ready to enjoy seamless media automation and an improved downloading experience!
