Class TorBoxClientOptions

Namespace

TorBoxSDK

Assembly

TorBoxSDK.dll

Configuration options for the TorBox SDK client.

public sealed class TorBoxClientOptions

Inheritance

object

TorBoxClientOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Use this class to configure API keys, base URLs, and timeout settings for the TorBoxClient and its sub-clients.

Properties

ApiKey

Gets or sets the API key used to authenticate requests to the TorBox API.

[Required]
public string ApiKey { get; set; }

Property Value

string

Remarks

This value is required. Obtain an API key from your TorBox account settings.

ApiVersion

Gets or sets the API version segment used to build the Main API path.

[Required]
public string ApiVersion { get; set; }

Property Value

string

Remarks

Defaults to v1. Combined with MainApiBaseUrl to produce the full base URL (e.g. https://api.torbox.app/v1/api/).

MainApiBaseUrl

Gets or sets the base URL for the Main API (host only, without version path).

public string MainApiBaseUrl { get; set; }

Property Value

string

Remarks

Defaults to https://api.torbox.app/. Override this value for testing or when using a custom endpoint. The trailing slash is required for correct relative URI resolution. Do not include the version segment — use ApiVersion instead.

MainApiVersionedUrl

Gets the fully-qualified Main API base URL including the version path.

public string MainApiVersionedUrl { get; }

Property Value

string

Remarks

Computed from MainApiBaseUrl and ApiVersion. For example, https://api.torbox.app/v1/api/.

RelayApiBaseUrl

Gets or sets the base URL for the Relay API (host only, without version path).

public string RelayApiBaseUrl { get; set; }

Property Value

string

Remarks

Defaults to https://relay.torbox.app/. Override this value for testing or when using a custom endpoint. The trailing slash is required for correct relative URI resolution. Do not include the version segment — use ApiVersion instead.

RelayApiVersionedUrl

Gets the fully-qualified Relay API base URL including the version path.

public string RelayApiVersionedUrl { get; }

Property Value

string

Remarks

Computed from RelayApiBaseUrl and ApiVersion. For example, https://relay.torbox.app/v1/.

SearchApiBaseUrl

Gets or sets the base URL for the Search API.

public string SearchApiBaseUrl { get; set; }

Property Value

string

Remarks

Defaults to https://search-api.torbox.app/. Override this value for testing or when using a custom endpoint. The trailing slash is required for correct relative URI resolution.

Timeout

Gets or sets the HTTP request timeout.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

Remarks

Defaults to 30 seconds. Increase this value for large file transfers or slow connections.