Skip to content

Files

Latest commit

 

History

History
136 lines (88 loc) · 5.64 KB

GeneralService.md

File metadata and controls

136 lines (88 loc) · 5.64 KB

GeneralService

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

Methods Description
getUpStatus ### Overview Simply gets if the TorBox API is available for use or not. Also might include information about downtimes. ### Authorization None needed.
getStats ### Overview Simply gets general stats about the TorBox service. ### Authorization None needed.
getChangelogsRssFeed ### Overview Gets most recent 100 changelogs from https://feedback.torbox.app/changelog. This is useful for people who want updates on the TorBox changelog. Includes all the necessary items to make this compatible with RSS feed viewers for notifications, and proper HTML viewing. ### Authorization None needed.
getChangelogsJson ### Overview Gets most recent 100 changelogs from https://feedback.torbox.app/changelog. This is useful for developers who want to integrate the changelog into their apps for their users to see. Includes content in HTML and markdown for developers to easily render the text in a fancy yet simple way. ### Authorization None needed.

getUpStatus

Overview Simply gets if the TorBox API is available for use or not. Also might include information about downtimes. ### Authorization None needed.

  • HTTP Method: GET
  • Endpoint: /

Return Type

GetUpStatusOkResponse

Example Usage Code Snippet

import { TorboxApi } from '@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.general.getUpStatus();

  console.log(data);
})();

getStats

Overview Simply gets general stats about the TorBox service. ### Authorization None needed.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/stats

Parameters

Name Type Required Description
apiVersion string ✅

Return Type

GetStatsOkResponse

Example Usage Code Snippet

import { TorboxApi } from '@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.general.getStats('api_version');

  console.log(data);
})();

getChangelogsRssFeed

Overview Gets most recent 100 changelogs from https://feedback.torbox.app/changelog. This is useful for people who want updates on the TorBox changelog. Includes all the necessary items to make this compatible with RSS feed viewers for notifications, and proper HTML viewing. ### Authorization None needed.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/changelogs/rss

Parameters

Name Type Required Description
apiVersion string ✅

Return Type

any

Example Usage Code Snippet

import { TorboxApi } from '@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.general.getChangelogsRssFeed('api_version');

  console.log(data);
})();

getChangelogsJson

Overview Gets most recent 100 changelogs from https://feedback.torbox.app/changelog. This is useful for developers who want to integrate the changelog into their apps for their users to see. Includes content in HTML and markdown for developers to easily render the text in a fancy yet simple way. ### Authorization None needed.

  • HTTP Method: GET
  • Endpoint: /{api_version}/api/changelogs/json

Parameters

Name Type Required Description
apiVersion string ✅

Return Type

GetChangelogsJsonOkResponse

Example Usage Code Snippet

import { TorboxApi } from '@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.general.getChangelogsJson('api_version');

  console.log(data);
})();