Ban 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.
ban.add_server_ban
await self.api.ban.add_server_ban(request: bedrock_server_manager.api.models.ban.AddServerBanRequest)
Async (Requires await): Yes
Description: Adds a player to the server ban list.
Returns:
AddServerBanResponse
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 AddServerBanRequest
payload = {...} # Supply required request fields below.
request = AddServerBanRequest(**payload)
result = await self.api.ban.add_server_ban(request)
data = result.model_dump(mode="json")
Request schema: AddServerBanRequest
Response schema: AddServerBanResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
ban.get_server_bans
await self.api.ban.get_server_bans(request: bedrock_server_manager.api.models.ban.GetServerBansRequest)
Async (Requires await): Yes
Description: Return all bans for a specific server.
Returns:
GetServerBansResponse
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 GetServerBansRequest
payload = {'server_name': 'example'}
request = GetServerBansRequest(**payload)
result = await self.api.ban.get_server_bans(request)
data = result.model_dump(mode="json")
Request schema: GetServerBansRequest
Response schema: GetServerBansResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|
ban.remove_server_ban
await self.api.ban.remove_server_ban(request: bedrock_server_manager.api.models.ban.RemoveServerBanRequest)
Async (Requires await): Yes
Description: Remove a player from the server ban list.
Returns:
RemoveServerBanResponse
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 RemoveServerBanRequest
payload = {...} # Supply required request fields below.
request = RemoveServerBanRequest(**payload)
result = await self.api.ban.remove_server_ban(request)
data = result.model_dump(mode="json")
Request schema: RemoveServerBanRequest
Response schema: RemoveServerBanResponse
Transport error schema: APIErrorResponse Parameters:
Name |
Type |
Default |
|---|---|---|
|
|
|