ServerApi.md

photoprism_client.ServerApi

All URIs are relative to http://demo.photoprism.app

Method	HTTP request	Description
get_status	GET /api/v1/status	reports if the server is operational

get_status

Dict[str, object] get_status()

reports if the server is operational

Example

import photoprism_client
from photoprism_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://demo.photoprism.app
# See configuration.py for a list of all supported configuration parameters.
configuration = photoprism_client.Configuration(
    host = "http://demo.photoprism.app"
)


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

    try:
        # reports if the server is operational
        api_response = api_instance.get_status()
        print("The response of ServerApi->get_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServerApi->get_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Dict[str, object]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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