Skip to content

System info

Check API Status

Code example
from ptsandbox import Sandbox, SandboxKey

async def example() -> None:
    key = SandboxKey(...)
    sandbox = Sandbox(key)

    status = await sandbox.api.get_health_status()
    print(status)

ptsandbox.sandbox.api._maintenance.MaintenanceMixin.get_health_status async 

get_health_status() -> SandboxGetHealthStatusResponse

Checking the API status

Raises:

  • ClientResponseError –

    if the server returns an error status

  • ClientError –

    on connection or transport errors

  • ValidationError –

    if the response body does not match the expected model

Get product version

Code example
from ptsandbox import Sandbox, SandboxKey

async def example() -> None:
    key = SandboxKey(...)
    sandbox = Sandbox(key)

    version = await sandbox.api.get_version()
    print(version)

ptsandbox.sandbox.api._maintenance.MaintenanceMixin.get_version async 

get_version() -> SandboxGetVersionResponse

Get information about product

Raises:

  • ClientResponseError –

    if the server returns an error status

  • ClientError –

    on connection or transport errors

  • ValidationError –

    if the response body does not match the expected model

Lifecycle

The Sandbox class manages HTTP sessions for both the Public API and UI API. Always close the sessions when you're done, either explicitly or via the async context manager:

Code example
from ptsandbox import Sandbox, SandboxKey

# Using the async context manager (recommended)
async with Sandbox(SandboxKey(...)) as sandbox:
    status = await sandbox.api.get_health_status()

# Or explicitly
sandbox = Sandbox(SandboxKey(...))
try:
    status = await sandbox.api.get_health_status()
finally:
    await sandbox.close()

ptsandbox.sandbox.sandbox.Sandbox.close async 

close() -> None

Close all underlying HTTP sessions (api and ui).