immortaly007/immich-to-cloud-exporter

Fork 0

Files

T

immortaly007 d50345fc64 [TASK] (untested) Updated API to work with Immich 3.0

2026-07-03 20:13:42 +02:00

34 KiB

Raw Blame History

generated.immich.openapi_client.ServerApi

All URIs are relative to https://github.com/api

Method	HTTP request	Description
delete_server_license	DELETE /server/license	Delete server product key
get_about_info	GET /server/about	Get server information
get_apk_links	GET /server/apk-links	Get APK links
get_server_config	GET /server/config	Get config
get_server_features	GET /server/features	Get features
get_server_license	GET /server/license	Get product key
get_server_statistics	GET /server/statistics	Get statistics
get_server_version	GET /server/version	Get server version
get_storage	GET /server/storage	Get storage
get_supported_media_types	GET /server/media-types	Get supported media types
get_version_check	GET /server/version-check	Get version check status
get_version_history	GET /server/version-history	Get version history
ping_server	GET /server/ping	Ping
set_server_license	PUT /server/license	Set server product key

delete_server_license

delete_server_license()

Delete server product key

Delete the currently set server product key.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

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:
        # Delete server product key
        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, api_key, bearer

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204		-

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

get_about_info

ServerAboutResponseDto get_about_info()

Get server information

Retrieve a list of information about the server.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

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:
        # Get server information
        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

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

get_apk_links

ServerApkLinksDto get_apk_links()

Get APK links

Retrieve links to the APKs for the current server version.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.server_apk_links_dto import ServerApkLinksDto
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:
        # Get APK links
        api_response = api_instance.get_apk_links()
        print("The response of ServerApi->get_apk_links:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServerApi->get_apk_links: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ServerApkLinksDto

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

get_server_config

ServerConfigDto get_server_config()

Get config

Retrieve the current server configuration.

Example

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:
        # Get config
        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

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] [Back to Model list] [Back to README]

get_server_features

ServerFeaturesDto get_server_features()

Get features

Retrieve available features supported by this server.

Example

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:
        # Get features
        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

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] [Back to Model list] [Back to README]

get_server_license

UserLicense get_server_license()

Get product key

Retrieve information about whether the server currently has a product key registered.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.user_license import UserLicense
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:
        # Get product key
        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

UserLicense

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

get_server_statistics

ServerStatsResponseDto get_server_statistics()

Get statistics

Retrieve statistics about the entire Immich instance such as asset counts.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

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:
        # Get statistics
        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

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

get_server_version

ServerVersionResponseDto get_server_version()

Get server version

Retrieve the current server version in semantic versioning (semver) format.

Example

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:
        # Get server version
        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

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] [Back to Model list] [Back to README]

get_storage

ServerStorageResponseDto get_storage()

Get storage

Retrieve the current storage utilization information of the server.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

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:
        # Get storage
        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

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

get_supported_media_types

ServerMediaTypesResponseDto get_supported_media_types()

Get supported media types

Retrieve all media types supported by the server.

Example

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:
        # Get supported media types
        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

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] [Back to Model list] [Back to README]

get_version_check

VersionCheckStateResponseDto get_version_check()

Get version check status

Retrieve information about the last time the version check ran.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.version_check_state_response_dto import VersionCheckStateResponseDto
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:
        # Get version check status
        api_response = api_instance.get_version_check()
        print("The response of ServerApi->get_version_check:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServerApi->get_version_check: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

VersionCheckStateResponseDto

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

get_version_history

List[ServerVersionHistoryResponseDto] get_version_history()

Get version history

Retrieve a list of past versions the server has been on.

Example

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:
        # Get version history
        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]

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] [Back to Model list] [Back to README]

ping_server

ServerPingResponse ping_server()

Ping

Pong

Example

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:
        # Ping
        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

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] [Back to Model list] [Back to README]

set_server_license

UserLicense set_server_license(license_key_dto)

Set server product key

Validate and set the server product key if successful.

Example

Api Key Authentication (cookie):
Api Key Authentication (api_key):
Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.license_key_dto import LicenseKeyDto
from generated.immich.openapi_client.models.user_license import UserLicense
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:
        # Set server product key
        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

Return type

UserLicense

Authorization

cookie, api_key, 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] [Back to Model list] [Back to README]

34 KiB Raw Blame History

generated.immich.openapi_client.ServerApi

delete_server_license

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_about_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_apk_links

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_server_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_server_features

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_server_license

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_server_statistics

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_server_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_storage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_supported_media_types

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version_check

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version_history

34 KiB

Raw Blame History