Skip to content

Latest commit

 

History

History
67 lines (36 loc) · 1.97 KB

PublicApi.md

File metadata and controls

67 lines (36 loc) · 1.97 KB

\PublicApi

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
get_status GET /status Get Seerr status
get_status_appdata GET /status/appdata Get application data volume status

get_status

models::GetStatus2XxResponse get_status(check_update_available) Get Seerr status

Returns the current Seerr status in a JSON object. updateAvailable and commitsBehind are omitted when checkUpdateAvailable is false.

Parameters

Name Type Description Required Notes
check_update_available Option<bool> If false, updateAvailable and commitsBehind will be omitted from the response. Defaults to the versionCheck setting.

Return type

models::GetStatus2XxResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_status_appdata

models::GetStatusAppdata2XxResponse get_status_appdata() Get application data volume status

For Docker installs, returns whether or not the volume mount was configured properly. Always returns true for non-Docker installs.

Parameters

This endpoint does not need any parameter.

Return type

models::GetStatusAppdata2XxResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]