embyapi.LibraryStructureServiceApi

All URIs are relative to https://home.ourflix.de:32865/emby

Method	HTTP request	Description
delete_library_virtualfolders	DELETE /Library/VirtualFolders
delete_library_virtualfolders_paths	DELETE /Library/VirtualFolders/Paths
get_library_virtualfolders	GET /Library/VirtualFolders
post_library_virtualfolders	POST /Library/VirtualFolders
post_library_virtualfolders_libraryoptions	POST /Library/VirtualFolders/LibraryOptions
post_library_virtualfolders_name	POST /Library/VirtualFolders/Name
post_library_virtualfolders_paths	POST /Library/VirtualFolders/Paths
post_library_virtualfolders_paths_update	POST /Library/VirtualFolders/Paths/Update

delete_library_virtualfolders

delete_library_virtualfolders()

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))

try:
    api_instance.delete_library_virtualfolders()
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->delete_library_virtualfolders: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

delete_library_virtualfolders_paths

delete_library_virtualfolders_paths()

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))

try:
    api_instance.delete_library_virtualfolders_paths()
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->delete_library_virtualfolders_paths: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get_library_virtualfolders

list[VirtualFolderInfo] get_library_virtualfolders()

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))

try:
    api_response = api_instance.get_library_virtualfolders()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->get_library_virtualfolders: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[VirtualFolderInfo]

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

post_library_virtualfolders

post_library_virtualfolders(body)

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))
body = embyapi.LibraryAddVirtualFolder() # LibraryAddVirtualFolder | AddVirtualFolder

try:
    api_instance.post_library_virtualfolders(body)
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->post_library_virtualfolders: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LibraryAddVirtualFolder	AddVirtualFolder

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_library_virtualfolders_libraryoptions

post_library_virtualfolders_libraryoptions(body)

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))
body = embyapi.LibraryUpdateLibraryOptions() # LibraryUpdateLibraryOptions | UpdateLibraryOptions

try:
    api_instance.post_library_virtualfolders_libraryoptions(body)
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->post_library_virtualfolders_libraryoptions: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LibraryUpdateLibraryOptions	UpdateLibraryOptions

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_library_virtualfolders_name

post_library_virtualfolders_name(body)

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))
body = embyapi.LibraryRenameVirtualFolder() # LibraryRenameVirtualFolder | RenameVirtualFolder

try:
    api_instance.post_library_virtualfolders_name(body)
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->post_library_virtualfolders_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LibraryRenameVirtualFolder	RenameVirtualFolder

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_library_virtualfolders_paths

post_library_virtualfolders_paths(body)

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))
body = embyapi.LibraryAddMediaPath() # LibraryAddMediaPath | AddMediaPath

try:
    api_instance.post_library_virtualfolders_paths(body)
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->post_library_virtualfolders_paths: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LibraryAddMediaPath	AddMediaPath

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

post_library_virtualfolders_paths_update

post_library_virtualfolders_paths_update(body)

Requires authentication as administrator

Example

from __future__ import print_function
import time
import embyapi
from embyapi.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikeyauth
configuration = embyapi.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = embyapi.LibraryStructureServiceApi(embyapi.ApiClient(configuration))
body = embyapi.LibraryUpdateMediaPath() # LibraryUpdateMediaPath | UpdateMediaPath

try:
    api_instance.post_library_virtualfolders_paths_update(body)
except ApiException as e:
    print("Exception when calling LibraryStructureServiceApi->post_library_virtualfolders_paths_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LibraryUpdateMediaPath	UpdateMediaPath

Return type

void (empty response body)

Authorization

apikeyauth, embyauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

Files

LibraryStructureServiceApi.md

Latest commit

History

LibraryStructureServiceApi.md

File metadata and controls

embyapi.LibraryStructureServiceApi

delete_library_virtualfolders

Example

Parameters

Return type

Authorization

HTTP request headers

delete_library_virtualfolders_paths

Example

Parameters

Return type

Authorization

HTTP request headers

get_library_virtualfolders

Example

Parameters

Return type

Authorization

HTTP request headers

post_library_virtualfolders

Example

Parameters

Return type

Authorization

HTTP request headers

post_library_virtualfolders_libraryoptions

Example

Parameters

Return type

Authorization

HTTP request headers

post_library_virtualfolders_name

Example

Parameters

Return type

Authorization

HTTP request headers

post_library_virtualfolders_paths

Example

Parameters

Return type

Authorization

HTTP request headers

post_library_virtualfolders_paths_update

Example

Parameters

Return type

Authorization

HTTP request headers