addon

Serializable addon API request and response contracts.

class bedrock_server_manager.api.models.addon.Subpack(*, folder_name: str, name: str | None = None, memory_tier: int | None = None)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.InstalledAddon(*, name: str, uuid: str, version: list[int], status: ~typing.Literal['ACTIVE', 'INACTIVE', 'ORPHANED'], path: str | None = None, subpacks: list[~bedrock_server_manager.api.models.addon.Subpack] = <factory>, icon: str | None = None, active_subpack: str | None = None)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.InstalledAddons(*, behavior_packs: list[InstalledAddon] = <factory>, resource_packs: list[InstalledAddon] = <factory>)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ListAvailableAddonsRequest

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ListAvailableAddonsResponse(*, status: Literal['success'] = 'success', message: str | None = None, files: list[str])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ImportAddonRequest(*, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], addon_file_path: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], stop_start_server: bool = True, restart_only_on_success: bool = True)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ImportAddonResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ListInstalledAddonsRequest(*, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ListInstalledAddonsResponse(*, status: Literal['success'] = 'success', message: str | None = None, addons: InstalledAddons)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.EnableAddonRequest(*, server_name: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], pack_uuid: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], pack_type: ~typing.Annotated[~typing.Literal['behavior', 'resource'], ~pydantic.functional_validators.BeforeValidator(func=~bedrock_server_manager.api.models.common.<lambda>, json_schema_input_type=PydanticUndefined)])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.EnableAddonResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.DisableAddonRequest(*, server_name: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], pack_uuid: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], pack_type: ~typing.Annotated[~typing.Literal['behavior', 'resource'], ~pydantic.functional_validators.BeforeValidator(func=~bedrock_server_manager.api.models.common.<lambda>, json_schema_input_type=PydanticUndefined)])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.DisableAddonResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.UpdateSubpackRequest(*, server_name: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], pack_uuid: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], pack_type: ~typing.Annotated[~typing.Literal['behavior', 'resource'], ~pydantic.functional_validators.BeforeValidator(func=~bedrock_server_manager.api.models.common.<lambda>, json_schema_input_type=PydanticUndefined)], subpack_name: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.UpdateSubpackResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.UninstallAddonRequest(*, server_name: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], pack_uuid: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], pack_type: ~typing.Annotated[~typing.Literal['behavior', 'resource'], ~pydantic.functional_validators.BeforeValidator(func=~bedrock_server_manager.api.models.common.<lambda>, json_schema_input_type=PydanticUndefined)])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.UninstallAddonResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ReorderAddonsRequest(*, server_name: ~typing.Annotated[str, ~pydantic.types.Strict(strict=True), ~annotated_types.MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], uuids: list[~typing.Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])]], pack_type: ~typing.Annotated[~typing.Literal['behavior', 'resource'], ~pydantic.functional_validators.BeforeValidator(func=~bedrock_server_manager.api.models.common.<lambda>, json_schema_input_type=PydanticUndefined)])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.addon.ReorderAddonsResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].