mirror of
https://github.com/LukeHagar/Prowlarr-TS-SDK.git
synced 2025-12-06 04:21:03 +00:00
53 lines
13 KiB
Markdown
53 lines
13 KiB
Markdown
# HostConfigResource
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { HostConfigResource } from "prowlarr/models";
|
|
|
|
let value: HostConfigResource = {};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
|
| `bindAddress` | *string* | :heavy_minus_sign: | N/A |
|
|
| `port` | *number* | :heavy_minus_sign: | N/A |
|
|
| `sslPort` | *number* | :heavy_minus_sign: | N/A |
|
|
| `enableSsl` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `launchBrowser` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `authenticationMethod` | [models.AuthenticationType](../models/authenticationtype.md) | :heavy_minus_sign: | N/A |
|
|
| `authenticationRequired` | [models.AuthenticationRequiredType](../models/authenticationrequiredtype.md) | :heavy_minus_sign: | N/A |
|
|
| `analyticsEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `username` | *string* | :heavy_minus_sign: | N/A |
|
|
| `password` | *string* | :heavy_minus_sign: | N/A |
|
|
| `passwordConfirmation` | *string* | :heavy_minus_sign: | N/A |
|
|
| `logLevel` | *string* | :heavy_minus_sign: | N/A |
|
|
| `logSizeLimit` | *number* | :heavy_minus_sign: | N/A |
|
|
| `consoleLogLevel` | *string* | :heavy_minus_sign: | N/A |
|
|
| `branch` | *string* | :heavy_minus_sign: | N/A |
|
|
| `apiKey` | *string* | :heavy_minus_sign: | N/A |
|
|
| `sslCertPath` | *string* | :heavy_minus_sign: | N/A |
|
|
| `sslCertPassword` | *string* | :heavy_minus_sign: | N/A |
|
|
| `urlBase` | *string* | :heavy_minus_sign: | N/A |
|
|
| `instanceName` | *string* | :heavy_minus_sign: | N/A |
|
|
| `applicationUrl` | *string* | :heavy_minus_sign: | N/A |
|
|
| `updateAutomatically` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `updateMechanism` | [models.UpdateMechanism](../models/updatemechanism.md) | :heavy_minus_sign: | N/A |
|
|
| `updateScriptPath` | *string* | :heavy_minus_sign: | N/A |
|
|
| `proxyEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `proxyType` | [models.ProxyType](../models/proxytype.md) | :heavy_minus_sign: | N/A |
|
|
| `proxyHostname` | *string* | :heavy_minus_sign: | N/A |
|
|
| `proxyPort` | *number* | :heavy_minus_sign: | N/A |
|
|
| `proxyUsername` | *string* | :heavy_minus_sign: | N/A |
|
|
| `proxyPassword` | *string* | :heavy_minus_sign: | N/A |
|
|
| `proxyBypassFilter` | *string* | :heavy_minus_sign: | N/A |
|
|
| `proxyBypassLocalAddresses` | *boolean* | :heavy_minus_sign: | N/A |
|
|
| `certificateValidation` | [models.CertificateValidationType](../models/certificatevalidationtype.md) | :heavy_minus_sign: | N/A |
|
|
| `backupFolder` | *string* | :heavy_minus_sign: | N/A |
|
|
| `backupInterval` | *number* | :heavy_minus_sign: | N/A |
|
|
| `backupRetention` | *number* | :heavy_minus_sign: | N/A |
|
|
| `historyCleanupDays` | *number* | :heavy_minus_sign: | N/A |
|
|
| `trustCgnatIpAddresses` | *boolean* | :heavy_minus_sign: | N/A | |