# generated.immich.openapi_client.ServerApi All URIs are relative to *https://github.com/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**delete_server_license**](ServerApi.md#delete_server_license) | **DELETE** /server/license | [**get_about_info**](ServerApi.md#get_about_info) | **GET** /server/about | [**get_server_config**](ServerApi.md#get_server_config) | **GET** /server/config | [**get_server_features**](ServerApi.md#get_server_features) | **GET** /server/features | [**get_server_license**](ServerApi.md#get_server_license) | **GET** /server/license | [**get_server_statistics**](ServerApi.md#get_server_statistics) | **GET** /server/statistics | [**get_server_version**](ServerApi.md#get_server_version) | **GET** /server/version | [**get_storage**](ServerApi.md#get_storage) | **GET** /server/storage | [**get_supported_media_types**](ServerApi.md#get_supported_media_types) | **GET** /server/media-types | [**get_theme**](ServerApi.md#get_theme) | **GET** /server/theme | [**get_version_history**](ServerApi.md#get_version_history) | **GET** /server/version-history | [**ping_server**](ServerApi.md#ping_server) | **GET** /server/ping | [**set_server_license**](ServerApi.md#set_server_license) | **PUT** /server/license | # **delete_server_license** > delete_server_license() ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_instance.delete_server_license() except Exception as e: print("Exception when calling ServerApi->delete_server_license: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type void (empty response body) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_about_info** > ServerAboutResponseDto get_about_info() ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_about_response_dto import ServerAboutResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_about_info() print("The response of ServerApi->get_about_info:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_about_info: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerAboutResponseDto**](ServerAboutResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_server_config** > ServerConfigDto get_server_config() ### Example ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_config_dto import ServerConfigDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_server_config() print("The response of ServerApi->get_server_config:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_server_config: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerConfigDto**](ServerConfigDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_server_features** > ServerFeaturesDto get_server_features() ### Example ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_features_dto import ServerFeaturesDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_server_features() print("The response of ServerApi->get_server_features:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_server_features: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerFeaturesDto**](ServerFeaturesDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_server_license** > LicenseResponseDto get_server_license() ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.license_response_dto import LicenseResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_server_license() print("The response of ServerApi->get_server_license:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_server_license: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**LicenseResponseDto**](LicenseResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | **404** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_server_statistics** > ServerStatsResponseDto get_server_statistics() ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_stats_response_dto import ServerStatsResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_server_statistics() print("The response of ServerApi->get_server_statistics:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_server_statistics: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerStatsResponseDto**](ServerStatsResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_server_version** > ServerVersionResponseDto get_server_version() ### Example ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_version_response_dto import ServerVersionResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_server_version() print("The response of ServerApi->get_server_version:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_server_version: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerVersionResponseDto**](ServerVersionResponseDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_storage** > ServerStorageResponseDto get_storage() ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_storage_response_dto import ServerStorageResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_storage() print("The response of ServerApi->get_storage:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_storage: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerStorageResponseDto**](ServerStorageResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_supported_media_types** > ServerMediaTypesResponseDto get_supported_media_types() ### Example ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_media_types_response_dto import ServerMediaTypesResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_supported_media_types() print("The response of ServerApi->get_supported_media_types:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_supported_media_types: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerMediaTypesResponseDto**](ServerMediaTypesResponseDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_theme** > ServerThemeDto get_theme() ### Example ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_theme_dto import ServerThemeDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_theme() print("The response of ServerApi->get_theme:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_theme: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerThemeDto**](ServerThemeDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_version_history** > List[ServerVersionHistoryResponseDto] get_version_history() ### Example ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_version_history_response_dto import ServerVersionHistoryResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.get_version_history() print("The response of ServerApi->get_version_history:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->get_version_history: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**List[ServerVersionHistoryResponseDto]**](ServerVersionHistoryResponseDto.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ping_server** > ServerPingResponse ping_server() ### Example ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.server_ping_response import ServerPingResponse from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) try: api_response = api_instance.ping_server() print("The response of ServerApi->ping_server:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->ping_server: %s\n" % e) ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ServerPingResponse**](ServerPingResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **set_server_license** > LicenseResponseDto set_server_license(license_key_dto) ### Example * Api Key Authentication (cookie): * Api Key Authentication (api_key): * Bearer (JWT) Authentication (bearer): ```python import generated.immich.openapi_client from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto from generated.immich.openapi_client.models.license_response_dto import LicenseResponseDto from generated.immich.openapi_client.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://github.com/api # See configuration.py for a list of all supported configuration parameters. configuration = generated.immich.openapi_client.Configuration( host = "https://github.com/api" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure API key authorization: cookie configuration.api_key['cookie'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['cookie'] = 'Bearer' # Configure API key authorization: api_key configuration.api_key['api_key'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['api_key'] = 'Bearer' # Configure Bearer authorization (JWT): bearer configuration = generated.immich.openapi_client.Configuration( access_token = os.environ["BEARER_TOKEN"] ) # Enter a context with an instance of the API client with generated.immich.openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = generated.immich.openapi_client.ServerApi(api_client) license_key_dto = generated.immich.openapi_client.LicenseKeyDto() # LicenseKeyDto | try: api_response = api_instance.set_server_license(license_key_dto) print("The response of ServerApi->set_server_license:\n") pprint(api_response) except Exception as e: print("Exception when calling ServerApi->set_server_license: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **license_key_dto** | [**LicenseKeyDto**](LicenseKeyDto.md)| | ### Return type [**LicenseResponseDto**](LicenseResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)