Raincloud/blender-portable-repo

Fork 0

Files

T

Raincloud 60100fbab2 2026-02-16

2026-03-17 15:25:32 -06:00

24 KiB

Raw Blame History

flamenco.manager.MetaApi

All URIs are relative to http://localhost

Method	HTTP request	Description
check_blender_exe_path	POST /api/v3/configuration/check/blender	Validate a CLI command for use as way to start Blender
check_shared_storage_path	POST /api/v3/configuration/check/shared-storage	Validate a path for use as shared storage.
find_blender_exe_path	GET /api/v3/configuration/check/blender	Find one or more CLI commands for use as way to start Blender
get_configuration	GET /api/v3/configuration	Get the configuration of this Manager.
get_configuration_file	GET /api/v3/configuration/file	Retrieve the configuration of Flamenco Manager.
get_farm_status	GET /api/v3/status	Get the status of this Flamenco farm.
get_shared_storage	GET /api/v3/configuration/shared-storage/{audience}/{platform}	Get the shared storage location of this Manager, adjusted for the given audience and platform.
get_variables	GET /api/v3/configuration/variables/{audience}/{platform}	Get the variables of this Manager. Used by the Blender add-on to recognise two-way variables, and for the web interface to do variable replacement based on the browser's platform.
get_version	GET /api/v3/version	Get the Flamenco version of this Manager
save_setup_assistant_config	POST /api/v3/configuration/setup-assistant	Update the Manager's configuration, and restart it in fully functional mode.
update_configuration_file	PUT /api/v3/configuration/file	Overwrites the configuration file. It does not actively reload the new configuration.

check_blender_exe_path

BlenderPathCheckResult check_blender_exe_path()

Validate a CLI command for use as way to start Blender

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.path_check_input import PathCheckInput
from flamenco.manager.model.blender_path_check_result import BlenderPathCheckResult
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)
    path_check_input = PathCheckInput(
        path="path_example",
    ) # PathCheckInput | Command or executable path to check (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Validate a CLI command for use as way to start Blender
        api_response = api_instance.check_blender_exe_path(path_check_input=path_check_input)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->check_blender_exe_path: %s\n" % e)

Parameters

Name	Type	Description	Notes
path_check_input	PathCheckInput	Command or executable path to check	[optional]

Return type

BlenderPathCheckResult

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Normal response, path check went fine.	-
0	Something went wrong.	-

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

check_shared_storage_path

PathCheckResult check_shared_storage_path()

Validate a path for use as shared storage.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.path_check_result import PathCheckResult
from flamenco.manager.model.path_check_input import PathCheckInput
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)
    path_check_input = PathCheckInput(
        path="path_example",
    ) # PathCheckInput | Path to check (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Validate a path for use as shared storage.
        api_response = api_instance.check_shared_storage_path(path_check_input=path_check_input)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->check_shared_storage_path: %s\n" % e)

Parameters

Name	Type	Description	Notes
path_check_input	PathCheckInput	Path to check	[optional]

Return type

PathCheckResult

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Normal response, path check went fine.	-
0	Something went wrong.	-

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

find_blender_exe_path

BlenderPathFindResult find_blender_exe_path()

Find one or more CLI commands for use as way to start Blender

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.blender_path_find_result import BlenderPathFindResult
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Find one or more CLI commands for use as way to start Blender
        api_response = api_instance.find_blender_exe_path()
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->find_blender_exe_path: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

BlenderPathFindResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Found locations of Blender.	-
0	Something went wrong.	-

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

get_configuration

ManagerConfiguration get_configuration()

Get the configuration of this Manager.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.manager_configuration import ManagerConfiguration
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get the configuration of this Manager.
        api_response = api_instance.get_configuration()
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->get_configuration: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ManagerConfiguration

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	normal response	-

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

get_configuration_file

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_configuration_file()

Retrieve the configuration of Flamenco Manager.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Retrieve the configuration of Flamenco Manager.
        api_response = api_instance.get_configuration_file()
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->get_configuration_file: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Normal response.	-

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

get_farm_status

FarmStatusReport get_farm_status()

Get the status of this Flamenco farm.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.farm_status_report import FarmStatusReport
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get the status of this Flamenco farm.
        api_response = api_instance.get_farm_status()
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->get_farm_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

FarmStatusReport

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	normal response	-

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

get_shared_storage

SharedStorageLocation get_shared_storage(audience, platform)

Get the shared storage location of this Manager, adjusted for the given audience and platform.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.manager_variable_audience import ManagerVariableAudience
from flamenco.manager.model.shared_storage_location import SharedStorageLocation
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)
    audience = ManagerVariableAudience("workers") # ManagerVariableAudience | 
    platform = "platform_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get the shared storage location of this Manager, adjusted for the given audience and platform. 
        api_response = api_instance.get_shared_storage(audience, platform)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->get_shared_storage: %s\n" % e)

Parameters

Name	Type	Description	Notes
audience	ManagerVariableAudience
platform	str

Return type

SharedStorageLocation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Normal response.	-

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

get_variables

ManagerVariables get_variables(audience, platform)

Get the variables of this Manager. Used by the Blender add-on to recognise two-way variables, and for the web interface to do variable replacement based on the browser's platform.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.manager_variable_audience import ManagerVariableAudience
from flamenco.manager.model.manager_variables import ManagerVariables
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)
    audience = ManagerVariableAudience("workers") # ManagerVariableAudience | 
    platform = "platform_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get the variables of this Manager. Used by the Blender add-on to recognise two-way variables, and for the web interface to do variable replacement based on the browser's platform. 
        api_response = api_instance.get_variables(audience, platform)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->get_variables: %s\n" % e)

Parameters

Name	Type	Description	Notes
audience	ManagerVariableAudience
platform	str

Return type

ManagerVariables

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Normal response.	-

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

get_version

FlamencoVersion get_version()

Get the Flamenco version of this Manager

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.flamenco_version import FlamencoVersion
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get the Flamenco version of this Manager
        api_response = api_instance.get_version()
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->get_version: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

FlamencoVersion

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	normal response	-

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

save_setup_assistant_config

save_setup_assistant_config()

Update the Manager's configuration, and restart it in fully functional mode.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.setup_assistant_config import SetupAssistantConfig
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)
    setup_assistant_config = SetupAssistantConfig(
        storage_location="storage_location_example",
        blender_executable=BlenderPathCheckResult(
            input="input_example",
            path="path_example",
            source=BlenderPathSource("file_association"),
            is_usable=True,
            cause="cause_example",
        ),
    ) # SetupAssistantConfig | Configuration to save. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update the Manager's configuration, and restart it in fully functional mode.
        api_instance.save_setup_assistant_config(setup_assistant_config=setup_assistant_config)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->save_setup_assistant_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
setup_assistant_config	SetupAssistantConfig	Configuration to save.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Normal response. The webapp should do a full refresh at this point.	-
0	Something went wrong.	-

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

update_configuration_file

update_configuration_file(body)

Overwrites the configuration file. It does not actively reload the new configuration.

Example

import time
import flamenco.manager
from flamenco.manager.api import meta_api
from flamenco.manager.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = meta_api.MetaApi(api_client)
    body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} | The configuration values as a JSON

    # example passing only required values which don't have defaults set
    try:
        # Overwrites the configuration file. It does not actively reload the new configuration.
        api_instance.update_configuration_file(body)
    except flamenco.manager.ApiException as e:
        print("Exception when calling MetaApi->update_configuration_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}	The configuration values as a JSON

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The configuration was successfully stored to flamenco-manager.yaml	-
0	Unable to save the configuration file	-

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

24 KiB Raw Blame History

flamenco.manager.MetaApi

check_blender_exe_path

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

check_shared_storage_path

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_blender_exe_path

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_configuration_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_farm_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_shared_storage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_variables

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_version

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

save_setup_assistant_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_configuration_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

24 KiB

Raw Blame History