`archivebox.api.v1_machine`

Module Contents

Classes

`MachineSchema`	Schema for Machine model.
`MachineFilterSchema`
`BinarySchema`	Schema for Binary model.
`BinaryFilterSchema`

Functions

`get_machines`	List all machines.
`get_current_machine`	Get the current machine.
`get_machine`	Get a specific machine by ID.
`get_binaries`	List all binaries.
`get_binary`	Get a specific binary by ID.
`get_binaries_by_name`	Get all binaries with the given name.

Data

router

API

archivebox.api.v1_machine.router[source]: ‘Router(…)’

class archivebox.api.v1_machine.MachineSchema[source]

Bases: ninja.Schema

Schema for Machine model.

TYPE: str[source]: ‘machine.Machine’

id: uuid.UUID[source]: None

created_at: datetime.datetime[source]: None

modified_at: datetime.datetime[source]: None

guid: str[source]: None

hostname: str[source]: None

hw_in_docker: bool[source]: None

hw_in_vm: bool[source]: None

hw_manufacturer: str[source]: None

hw_product: str[source]: None

hw_uuid: str[source]: None

os_arch: str[source]: None

os_family: str[source]: None

os_platform: str[source]: None

os_release: str[source]: None

os_kernel: str[source]: None

stats: dict[source]: None

num_uses_succeeded: int[source]: None

num_uses_failed: int[source]: None

class archivebox.api.v1_machine.MachineFilterSchema[source]

Bases: ninja.FilterSchema

id: Annotated[str | None, FilterLookup('id__startswith')][source]: None

hostname: Annotated[str | None, FilterLookup('hostname__icontains')][source]: None

os_platform: Annotated[str | None, FilterLookup('os_platform__icontains')][source]: None

os_arch: Annotated[str | None, FilterLookup('os_arch')][source]: None

hw_in_docker: Annotated[bool | None, FilterLookup('hw_in_docker')][source]: None

hw_in_vm: Annotated[bool | None, FilterLookup('hw_in_vm')][source]: None

bin_providers: Annotated[str | None, FilterLookup('bin_providers__icontains')][source]: None

class archivebox.api.v1_machine.BinarySchema[source]