Diagnostics 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.

diagnostics.compare_diagnostic_snapshots

await self.api.diagnostics.compare_diagnostic_snapshots(request: bedrock_server_manager.api.models.diagnostics.CompareDiagnosticSnapshotsRequest)

  • Async (Requires await): Yes

  • Description: Compare metadata snapshots without treating restarted counters as activity.

  • Returns: CompareDiagnosticSnapshotsResponse

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 CompareDiagnosticSnapshotsRequest
payload = {...}  # Supply required request fields below.
request = CompareDiagnosticSnapshotsRequest(**payload)
result = await self.api.diagnostics.compare_diagnostic_snapshots(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.diagnostics.CompareDiagnosticSnapshotsRequest

REQUIRED

diagnostics.get_application_diagnostics

await self.api.diagnostics.get_application_diagnostics(request: bedrock_server_manager.api.models.diagnostics.GetApplicationDiagnosticsRequest)

  • Async (Requires await): Yes

  • Description: Read bounded subsystem metadata; unavailable providers remain isolated.

  • Returns: GetApplicationDiagnosticsResponse

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 GetApplicationDiagnosticsRequest
payload = {}
request = GetApplicationDiagnosticsRequest(**payload)
result = await self.api.diagnostics.get_application_diagnostics(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.diagnostics.GetApplicationDiagnosticsRequest

REQUIRED

diagnostics.get_diagnostic_activity

await self.api.diagnostics.get_diagnostic_activity(request: bedrock_server_manager.api.models.diagnostics.GetDiagnosticActivityRequest)

  • Async (Requires await): Yes

  • Description: Read all-chain event, operation, and subscription metadata without payloads.

  • Returns: GetDiagnosticActivityResponse

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 GetDiagnosticActivityRequest
payload = {}
request = GetDiagnosticActivityRequest(**payload)
result = await self.api.diagnostics.get_diagnostic_activity(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.diagnostics.GetDiagnosticActivityRequest

REQUIRED

diagnostics.get_diagnostic_history

await self.api.diagnostics.get_diagnostic_history(request: bedrock_server_manager.api.models.diagnostics.GetDiagnosticHistoryRequest)

  • Async (Requires await): Yes

  • Description: Read sanitized retained records, optionally scoped to an application run.

  • Returns: GetDiagnosticHistoryResponse

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 GetDiagnosticHistoryRequest
payload = {}
request = GetDiagnosticHistoryRequest(**payload)
result = await self.api.diagnostics.get_diagnostic_history(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.diagnostics.GetDiagnosticHistoryRequest

REQUIRED

diagnostics.get_diagnostic_report

await self.api.diagnostics.get_diagnostic_report(request: bedrock_server_manager.api.models.diagnostics.GetDiagnosticReportRequest)

  • Async (Requires await): Yes

  • Description: Build a support report without secrets, task arguments, or event payloads.

  • Returns: GetDiagnosticReportResponse

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 GetDiagnosticReportRequest
payload = {}
request = GetDiagnosticReportRequest(**payload)
result = await self.api.diagnostics.get_diagnostic_report(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.diagnostics.GetDiagnosticReportRequest

REQUIRED

diagnostics.get_diagnostic_runs

await self.api.diagnostics.get_diagnostic_runs(request: bedrock_server_manager.api.models.diagnostics.GetDiagnosticRunsRequest)

  • Async (Requires await): Yes

  • Description: List retained application instances without guessing whether older runs are alive.

  • Returns: GetDiagnosticRunsResponse

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 GetDiagnosticRunsRequest
payload = {}
request = GetDiagnosticRunsRequest(**payload)
result = await self.api.diagnostics.get_diagnostic_runs(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.diagnostics.GetDiagnosticRunsRequest

REQUIRED

diagnostics.get_diagnostic_trace

await self.api.diagnostics.get_diagnostic_trace(request: bedrock_server_manager.api.models.diagnostics.GetDiagnosticTraceRequest)

  • Async (Requires await): Yes

  • Description: Read events, tasks, and retained failures sharing one correlation identity.

  • Returns: GetDiagnosticTraceResponse

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 GetDiagnosticTraceRequest
payload = {...}  # Supply required request fields below.
request = GetDiagnosticTraceRequest(**payload)
result = await self.api.diagnostics.get_diagnostic_trace(request)
data = result.model_dump(mode="json")

Name

Type

Default

request

bedrock_server_manager.api.models.diagnostics.GetDiagnosticTraceRequest

REQUIRED