Skip to content

PublicApi.md

Latest commit

 

History

History
142 lines (91 loc) · 4.27 KB

PublicApi.md

File metadata and controls

142 lines (91 loc) · 4.27 KB
Raw

seerr.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

GetStatus2XXResponse get_status(check_update_available=check_update_available)

Get Seerr status

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

Example

import seerr
from seerr.models.get_status2_xx_response import GetStatus2XXResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.PublicApi(api_client)
    check_update_available = false # bool | If false, updateAvailable and commitsBehind will be omitted from the response. Defaults to the versionCheck setting. (optional)

    try:
        # Get Seerr status
        api_response = api_instance.get_status(check_update_available=check_update_available)
        print("The response of PublicApi->get_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_status: %s\n" % e)

Parameters

Name Type Description Notes
check_update_available bool If false, updateAvailable and commitsBehind will be omitted from the response. Defaults to the versionCheck setting. [optional]

Return type

GetStatus2XXResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
2XX Returned status -

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

get_status_appdata

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.

Example

import seerr
from seerr.models.get_status_appdata2_xx_response import GetStatusAppdata2XXResponse
from seerr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:5055/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = seerr.Configuration(
    host = "http://localhost:5055/api/v1"
)


# Enter a context with an instance of the API client
with seerr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = seerr.PublicApi(api_client)

    try:
        # Get application data volume status
        api_response = api_instance.get_status_appdata()
        print("The response of PublicApi->get_status_appdata:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_status_appdata: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetStatusAppdata2XXResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
2XX Application data volume status and path -

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