Pulsarr

Get configuration

GET
/v1/config

Retrieve the current application configuration settings

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Response Body

Default Response

application/json
  1. response

Configuration response envelope

success*boolean
config*

Complete application configuration; server-internal secrets are never included

webhooks?

Per-instance webhook outcomes for every Radarr and Sonarr

Example Request
curl -X GET 'http://localhost:3003/v1/config'
Example Response
{  "success": true,  "config": {    "id": 0,    "created_at": "string",    "updated_at": "string",    "baseUrl": "string",    "port": 1,    "dbPath": "string",    "cookieSecured": true,    "logLevel": "fatal",    "closeGraceDelay": 0,    "rateLimitMax": 0,    "queueProcessDelaySeconds": 0,    "maintainerrEnabled": true,    "maintainerrUrl": "string",    "maintainerrExclusionMode": "watchlisters",    "discordWebhookUrl": "string",    "discordBotToken": "string",    "discordClientId": "string",    "enableApprise": true,    "appriseUrl": "string",    "systemAppriseUrl": "string",    "appriseEmailSender": "string",    "publicContentNotifications": {      "enabled": true,      "discordWebhookUrls": "string",      "discordWebhookUrlsMovies": "string",      "discordWebhookUrlsShows": "string",      "appriseUrls": "string",      "appriseUrlsMovies": "string",      "appriseUrlsShows": "string"    },    "plexMobileEnabled": true,    "deletionMode": "watchlist",    "queueWaitTime": 0,    "newEpisodeThreshold": 0,    "notifyOnUpdate": "none",    "notifyOnAvailability": true,    "pendingWebhookRetryInterval": 0,    "pendingWebhookMaxAge": 0,    "pendingWebhookCleanupInterval": 0,    "tmdbRegion": "string",    "plexTokens": [      "string"    ],    "skipFriendSync": true,    "plexServerUrl": "string",    "skipIfExistsOnPlex": true,    "deleteMovie": true,    "deleteEndedShow": true,    "deleteContinuingShow": true,    "deleteFiles": true,    "respectUserSyncSetting": true,    "deleteSyncNotify": "none",    "approvalNotify": "none",    "watchlistCapNotify": "none",    "watchlistCapNotifyUser": true,    "watchlistAddNotify": "none",    "deleteSyncNotifyOnlyOnDeletion": true,    "maxDeletionPrevention": 0,    "deleteSyncTrackedOnly": true,    "deleteSyncCleanupApprovals": true,    "deleteSyncRequiredTagRegex": "string",    "enablePlexPlaylistProtection": true,    "plexProtectionPlaylistName": "string",    "plexLabelSync": {      "enabled": true,      "labelPrefix": "string",      "labelNamingSource": "username",      "cleanupOrphanedLabels": true,      "removedLabelMode": "remove",      "removedLabelPrefix": "string",      "autoResetOnScheduledSync": true,      "tagSync": {        "enabled": true,        "syncRadarrTags": true,        "syncSonarrTags": true      }    },    "selfRss": "string",    "friendsRss": "string",    "tagUsersInSonarr": true,    "tagUsersInRadarr": true,    "cleanupOrphanedTags": true,    "tagPrefix": "string",    "tagNamingSource": "username",    "removedTagMode": "remove",    "removedTagPrefix": "string",    "tagMigration": {      "radarr": {        "property1": {          "completed": true,          "migratedAt": "string",          "tagsMigrated": 0,          "contentUpdated": 0        },        "property2": {          "completed": true,          "migratedAt": "string",          "tagsMigrated": 0,          "contentUpdated": 0        }      },      "sonarr": {        "property1": {          "completed": true,          "migratedAt": "string",          "tagsMigrated": 0,          "contentUpdated": 0        },        "property2": {          "completed": true,          "migratedAt": "string",          "tagsMigrated": 0,          "contentUpdated": 0        }      }    },    "plexSessionMonitoring": {      "enabled": true,      "pollingIntervalMinutes": 0,      "remainingEpisodes": 0,      "filterUsers": [        "string"      ],      "enableAutoReset": true,      "inactivityResetDays": 0,      "autoResetIntervalHours": 0,      "enableProgressiveCleanup": true    },    "newUserDefaultCanSync": true,    "newUserDefaultRequiresApproval": true,    "newUserDefaultMovieQuotaEnabled": true,    "newUserDefaultMovieQuotaType": "daily",    "newUserDefaultMovieQuotaLimit": 0,    "newUserDefaultMovieBypassApproval": true,    "newUserDefaultMovieWatchlistCap": 0,    "newUserDefaultShowQuotaEnabled": true,    "newUserDefaultShowQuotaType": "daily",    "newUserDefaultShowQuotaLimit": 0,    "newUserDefaultShowBypassApproval": true,    "newUserDefaultShowWatchlistCap": 0,    "quotaSettings": {      "cleanup": {        "enabled": true,        "retentionDays": 0      },      "weeklyRolling": {        "resetDays": 0      },      "monthly": {        "resetDay": 0,        "handleMonthEnd": "last-day"      }    },    "approvalExpiration": {      "enabled": true,      "defaultExpirationHours": 0,      "expirationAction": "expire",      "autoApproveOnQuotaAvailable": true,      "quotaExceededExpirationHours": 0,      "routerRuleExpirationHours": 0,      "manualFlagExpirationHours": 0,      "contentCriteriaExpirationHours": 0,      "cleanupExpiredDays": 0    },    "_isReady": true  },  "webhooks": {    "radarr": [      {        "instanceId": 0,        "name": "string",        "success": true,        "code": "callback_failed",        "message": "string"      }    ],    "sonarr": [      {        "instanceId": 0,        "name": "string",        "success": true,        "code": "callback_failed",        "message": "string"      }    ]  }}