Skip to content

Files

Latest commit

1c0e192 · Apr 26, 2025

History

History
83 lines (56 loc) · 4.74 KB

QueuedService.md

File metadata and controls

83 lines (56 loc) · 4.74 KB

QueuedService

A list of all methods in the QueuedService service. Click on the method name to view detailed information about that method.

Methods Description
getQueuedDownloads ### Overview Retrieves all of a user's queued downloads by type. If you want to get all 3 types, "torrent", "usenet" and "webdl" then you will need to run this request 3 times, each with the different type. ### Authorization Requires an API key using the Authorization Bearer Header.
controlQueuedDownloads ### Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - Delete deletes the queued download from your account - Start starts a queued download, cannot be used with the "all" parameter ### Authorization Requires an API key using the Authorization Bearer Header.

getQueuedDownloads

Overview Retrieves all of a user's queued downloads by type. If you want to get all 3 types, "torrent", "usenet" and "webdl" then you will need to run this request 3 times, each with the different type. ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/queued/getqueued

Parameters

Name Type Required Description
apiVersion String
requestParameters GetQueuedDownloadsParameters Request Parameters Object

Example Usage Code Snippet

import app.torbox.torbox.TorboxApi;
import app.torbox.torbox.config.TorboxApiConfig;
import app.torbox.torbox.models.GetQueuedDownloadsParameters;

public class Main {

  public static void main(String[] args) {
    TorboxApiConfig config = TorboxApiConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();

    TorboxApi torboxApi = new TorboxApi(config);

    GetQueuedDownloadsParameters requestParameters = GetQueuedDownloadsParameters.builder()
      .bypassCache("boolean")
      .id("integer")
      .offset("integer")
      .limit("integer")
      .type("string")
      .build();

    torboxApi.queued.getQueuedDownloads("api_version", requestParameters);
  }
}

controlQueuedDownloads

Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - Delete deletes the queued download from your account - Start starts a queued download, cannot be used with the "all" parameter ### Authorization Requires an API key using the Authorization Bearer Header.

  • HTTP Method: POST
  • Endpoint: /{api_version}/api/queued/controlqueued

Parameters

Name Type Required Description
apiVersion String
input Object Request Body

Example Usage Code Snippet

import app.torbox.torbox.TorboxApi;
import app.torbox.torbox.config.TorboxApiConfig;

public class Main {

  public static void main(String[] args) {
    TorboxApiConfig config = TorboxApiConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();

    TorboxApi torboxApi = new TorboxApi(config);

    torboxApi.queued.controlQueuedDownloads("api_version", new Object());
  }
}