Prowlarr-TS-SDK/docs/sdks/system

System

(system)

Overview

Available Operations

• getApiV1SystemStatus
• getApiV1SystemRoutes
• getApiV1SystemRoutesDuplicate
• postApiV1SystemShutdown
• postApiV1SystemRestart

getApiV1SystemStatus

Example Usage

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const result = await prowlarr.system.getApiV1SystemStatus();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { systemGetApiV1SystemStatus } from "prowlarr/funcs/systemGetApiV1SystemStatus.js";

// Use `ProwlarrCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const prowlarr = new ProwlarrCore({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const res = await systemGetApiV1SystemStatus(prowlarr);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.SystemResource>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	*/*

getApiV1SystemRoutes

Example Usage

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  await prowlarr.system.getApiV1SystemRoutes();


}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { systemGetApiV1SystemRoutes } from "prowlarr/funcs/systemGetApiV1SystemRoutes.js";

// Use `ProwlarrCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const prowlarr = new ProwlarrCore({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const res = await systemGetApiV1SystemRoutes(prowlarr);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	*/*

getApiV1SystemRoutesDuplicate

Example Usage

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  await prowlarr.system.getApiV1SystemRoutesDuplicate();


}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { systemGetApiV1SystemRoutesDuplicate } from "prowlarr/funcs/systemGetApiV1SystemRoutesDuplicate.js";

// Use `ProwlarrCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const prowlarr = new ProwlarrCore({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const res = await systemGetApiV1SystemRoutesDuplicate(prowlarr);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	*/*

postApiV1SystemShutdown

Example Usage

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  await prowlarr.system.postApiV1SystemShutdown();


}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { systemPostApiV1SystemShutdown } from "prowlarr/funcs/systemPostApiV1SystemShutdown.js";

// Use `ProwlarrCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const prowlarr = new ProwlarrCore({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const res = await systemPostApiV1SystemShutdown(prowlarr);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	*/*

postApiV1SystemRestart

Example Usage

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  await prowlarr.system.postApiV1SystemRestart();


}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { systemPostApiV1SystemRestart } from "prowlarr/funcs/systemPostApiV1SystemRestart.js";

// Use `ProwlarrCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const prowlarr = new ProwlarrCore({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  const res = await systemPostApiV1SystemRestart(prowlarr);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	*/*