Misc plugin APIs

Generated from registered core contracts.


This list contains all functions available to plugins via the self.api object. For an updated list of available APIs, please download and run the api_docs_generator plugin.

misc.prune_download_cache

await self.api.misc.prune_download_cache(request: bedrock_server_manager.api.models.misc.PruneDownloadCacheRequest)
  • Async (Requires await): Yes

  • Description: Prunes old downloaded server archives (.zip) in a directory.

  • Returns: PruneDownloadCacheResponse

Runtime context and plugin identity are injected by the bridge. Failures raise application exceptions; plugin cancellation raises APICancelledError.

from bedrock_server_manager.api.models import PruneDownloadCacheRequest
payload = {...}  # Supply required request fields below.
request = PruneDownloadCacheRequest(**payload)
result = await self.api.misc.prune_download_cache(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.misc.PruneDownloadCacheRequest

REQUIRED