API Socks

API Connections without needing to Reverse Proxy Services

Summary

Do you need access to a services API through WAN but don't want to reverse proxy it? Organizr can help with that... All you need to do is, enable that option under that Services homepage item. After that, you are off to the races.

Supported Apps

Application

Supports Multiple Servers

Sonarr

Yes

Radarr

Yes

Lidarr

Yes

Tautulli

Yes

SabNZBd

No

NZBGet

No

qBittorrent

No

URL Endpoints

Make sure to replace the corresponding fields

Field

Value

{ORGANIZR_DOMAIN}

Domain of your Organizr instance

{SERVICE}

Supported Application

http://{ORGANIZR_DOMAIN}/api/v2/socks/{SERVICE}/

I.E.

http://demo.organizr.app/api/v2/socks/sonarr/

Example API Call

API Socks

GET https://demo.organizr.app/api/v2/socks/sonarr/api/system/status?apikey=sonarrAPIkey

Calls Sonarr's API

Path Parameters

NameTypeDescription

apikey

string

Sonarr's API Key

Headers

NameTypeDescription

Token

string

Organizr's API Key

{
  "version": "3.0.6.1265",
  "buildTime": "2021-06-17T12:24:54Z",
  "isDebug": false,
  "isProduction": true,
  "isAdmin": false,
  "isUserInteractive": false,
  "startupPath": "/app/sonarr/bin",
  "appData": "/config",
  "osName": "ubuntu",
  "osVersion": "18.04",
  "isMonoRuntime": true,
  "isMono": true,
  "isLinux": true,
  "isOsx": false,
  "isWindows": false,
  "branch": "main",
  "authentication": "none",
  "sqliteVersion": "3.22.0",
  "urlBase": "",
  "runtimeVersion": "5.20.1.34",
  "runtimeName": "mono"
}

Last updated