Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 2.48 KB

general_service.md

File metadata and controls

85 lines (59 loc) · 2.48 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.

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: /

Parameters

Name Type Required Description
ctx Context ✅ Default go language context

Return Type

GetUpStatusOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)

response, err := client.General.GetUpStatus(context.Background())
if err != nil {
  panic(err)
}

fmt.Println(response)

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
ctx Context ✅ Default go language context
apiVersion string ✅

Return Type

GetStatsOkResponse

Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "torbox-sdk-go/pkg/torboxapiconfig"
  "torbox-sdk-go/pkg/torboxapi"
)

config := torboxapiconfig.NewConfig()
client := torboxapi.NewTorboxApi(config)

response, err := client.General.GetStats(context.Background(), "apiVersion")
if err != nil {
  panic(err)
}

fmt.Println(response)