Allowlist 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.
allowlist.add_to_allowlist
await self.api.allowlist.add_to_allowlist(request: bedrock_server_manager.api.models.allowlist.AddToAllowlistRequest)
Async (Requires await): Yes
Description: Adds a list of players to the server’s allowlist.
Returns:
AddToAllowlistResponse
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 AddToAllowlistRequest
payload = {...} # Supply required request fields below.
request = AddToAllowlistRequest(**payload)
result = await self.api.allowlist.add_to_allowlist(request)
data = result.model_dump(mode="json")
Request schema: AddToAllowlistRequest
Response schema: AddToAllowlistResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
allowlist.get_allowlist
await self.api.allowlist.get_allowlist(request: bedrock_server_manager.api.models.allowlist.GetAllowlistRequest)
Async (Requires await): Yes
Description: Return the current allowlist for a given server.
Returns:
GetAllowlistResponse
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 GetAllowlistRequest
payload = {'server_name': 'example'}
request = GetAllowlistRequest(**payload)
result = await self.api.allowlist.get_allowlist(request)
data = result.model_dump(mode="json")
Request schema: GetAllowlistRequest
Response schema: GetAllowlistResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
allowlist.remove_from_allowlist
await self.api.allowlist.remove_from_allowlist(request: bedrock_server_manager.api.models.allowlist.RemoveFromAllowlistRequest)
Async (Requires await): Yes
Description: Remove a list of players from the server’s allowlist.
Returns:
RemoveFromAllowlistResponse
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 RemoveFromAllowlistRequest
payload = {...} # Supply required request fields below.
request = RemoveFromAllowlistRequest(**payload)
result = await self.api.allowlist.remove_from_allowlist(request)
data = result.model_dump(mode="json")
Request schema: RemoveFromAllowlistRequest
Response schema: RemoveFromAllowlistResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|