The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-14 11:06:13 +05:00
Code Issues Actions Packages Projects Releases Wiki Activity
dev
ArchiveBox/docs/apidocs/archivebox/archivebox.api.v1_machine.md
Nick Sweeting f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Details
Build Debian package / build (amd64) (push) Waiting to run
Details
Build Debian package / build (arm64) (push) Waiting to run
Details
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Details
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Details
Build Debian package / release (push) Blocked by required conditions
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Details
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Details
Run linters / lint (push) Waiting to run
Details
Build Pip package / build (push) Waiting to run
Details
Release State / release-state (push) Waiting to run
Details
Parallel Tests / Discover test files (push) Waiting to run
Details
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Details
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Details
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Details
Run tests / docker_tests (push) Waiting to run
Details
docs: regenerate sphinx apidocs to reflect current source tree 
Clean rebuild of docs/apidocs/archivebox/ via autodoc2:
- Removes 19 stale module pages whose source files no longer exist
  (cli_utils, host_utils, schedule_utils — renamed to *_util; actors,
  ideas, debugging, folders, legacy, progress_layout, tests_piping,
  config_tags, personas.runtime/views, orchestrator*, worker, tasks).
- Adds 29 new module pages for code that was added since the previous
  generation but not yet documented.
- Updates 100 existing pages to reflect API surface changes (e.g.
  ENABLED_PLUGINS Field removed, SNAPSHOTS_PER_PAGE clamp removed,
  default bumped to 50, etc.).

156 source modules <-> 156 apidoc files (zero drift). Build clean
under sphinx-build -W --keep-going.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-31 03:40:25 -07:00

15 KiB
Raw Permalink Blame History

{py:mod}archivebox.api.v1_machine

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`MachineSchema <archivebox.api.v1_machine.MachineSchema>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema
    :summary:
    ```
* - {py:obj}`MachineFilterSchema <archivebox.api.v1_machine.MachineFilterSchema>`
  -
* - {py:obj}`BinarySchema <archivebox.api.v1_machine.BinarySchema>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema
    :summary:
    ```
* - {py:obj}`BinaryFilterSchema <archivebox.api.v1_machine.BinaryFilterSchema>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`get_machines <archivebox.api.v1_machine.get_machines>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.get_machines
    :summary:
    ```
* - {py:obj}`get_current_machine <archivebox.api.v1_machine.get_current_machine>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.get_current_machine
    :summary:
    ```
* - {py:obj}`get_machine <archivebox.api.v1_machine.get_machine>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.get_machine
    :summary:
    ```
* - {py:obj}`get_binaries <archivebox.api.v1_machine.get_binaries>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.get_binaries
    :summary:
    ```
* - {py:obj}`get_binary <archivebox.api.v1_machine.get_binary>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.get_binary
    :summary:
    ```
* - {py:obj}`get_binaries_by_name <archivebox.api.v1_machine.get_binaries_by_name>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.get_binaries_by_name
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`router <archivebox.api.v1_machine.router>`
  - ```{autodoc2-docstring} archivebox.api.v1_machine.router
    :summary:
    ```

API

:canonical: archivebox.api.v1_machine.router
:value: >
   'Router(...)'

```{autodoc2-docstring} archivebox.api.v1_machine.router
```


:canonical: archivebox.api.v1_machine.MachineSchema

Bases: {py:obj}`ninja.Schema`

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.__init__
```

````{py:attribute} TYPE
:canonical: archivebox.api.v1_machine.MachineSchema.TYPE
:type: str
:value: >
   'machine.Machine'

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.TYPE
```

````

````{py:attribute} id
:canonical: archivebox.api.v1_machine.MachineSchema.id
:type: uuid.UUID
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.id
```

````

````{py:attribute} created_at
:canonical: archivebox.api.v1_machine.MachineSchema.created_at
:type: datetime.datetime
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.created_at
```

````

````{py:attribute} modified_at
:canonical: archivebox.api.v1_machine.MachineSchema.modified_at
:type: datetime.datetime
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.modified_at
```

````

````{py:attribute} guid
:canonical: archivebox.api.v1_machine.MachineSchema.guid
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.guid
```

````

````{py:attribute} hostname
:canonical: archivebox.api.v1_machine.MachineSchema.hostname
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.hostname
```

````

````{py:attribute} hw_in_docker
:canonical: archivebox.api.v1_machine.MachineSchema.hw_in_docker
:type: bool
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.hw_in_docker
```

````

````{py:attribute} hw_in_vm
:canonical: archivebox.api.v1_machine.MachineSchema.hw_in_vm
:type: bool
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.hw_in_vm
```

````

````{py:attribute} hw_manufacturer
:canonical: archivebox.api.v1_machine.MachineSchema.hw_manufacturer
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.hw_manufacturer
```

````

````{py:attribute} hw_product
:canonical: archivebox.api.v1_machine.MachineSchema.hw_product
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.hw_product
```

````

````{py:attribute} hw_uuid
:canonical: archivebox.api.v1_machine.MachineSchema.hw_uuid
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.hw_uuid
```

````

````{py:attribute} os_arch
:canonical: archivebox.api.v1_machine.MachineSchema.os_arch
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.os_arch
```

````

````{py:attribute} os_family
:canonical: archivebox.api.v1_machine.MachineSchema.os_family
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.os_family
```

````

````{py:attribute} os_platform
:canonical: archivebox.api.v1_machine.MachineSchema.os_platform
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.os_platform
```

````

````{py:attribute} os_release
:canonical: archivebox.api.v1_machine.MachineSchema.os_release
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.os_release
```

````

````{py:attribute} os_kernel
:canonical: archivebox.api.v1_machine.MachineSchema.os_kernel
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.os_kernel
```

````

````{py:attribute} stats
:canonical: archivebox.api.v1_machine.MachineSchema.stats
:type: dict
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.stats
```

````

````{py:attribute} num_uses_succeeded
:canonical: archivebox.api.v1_machine.MachineSchema.num_uses_succeeded
:type: int
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.num_uses_succeeded
```

````

````{py:attribute} num_uses_failed
:canonical: archivebox.api.v1_machine.MachineSchema.num_uses_failed
:type: int
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineSchema.num_uses_failed
```

````


:canonical: archivebox.api.v1_machine.MachineFilterSchema

Bases: {py:obj}`ninja.FilterSchema`

````{py:attribute} id
:canonical: archivebox.api.v1_machine.MachineFilterSchema.id
:type: typing.Annotated[str | None, FilterLookup('id__startswith')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineFilterSchema.id
```

````

````{py:attribute} hostname
:canonical: archivebox.api.v1_machine.MachineFilterSchema.hostname
:type: typing.Annotated[str | None, FilterLookup('hostname__icontains')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineFilterSchema.hostname
```

````

````{py:attribute} os_platform
:canonical: archivebox.api.v1_machine.MachineFilterSchema.os_platform
:type: typing.Annotated[str | None, FilterLookup('os_platform__icontains')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineFilterSchema.os_platform
```

````

````{py:attribute} os_arch
:canonical: archivebox.api.v1_machine.MachineFilterSchema.os_arch
:type: typing.Annotated[str | None, FilterLookup('os_arch')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineFilterSchema.os_arch
```

````

````{py:attribute} hw_in_docker
:canonical: archivebox.api.v1_machine.MachineFilterSchema.hw_in_docker
:type: typing.Annotated[bool | None, FilterLookup('hw_in_docker')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineFilterSchema.hw_in_docker
```

````

````{py:attribute} hw_in_vm
:canonical: archivebox.api.v1_machine.MachineFilterSchema.hw_in_vm
:type: typing.Annotated[bool | None, FilterLookup('hw_in_vm')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineFilterSchema.hw_in_vm
```

````

````{py:attribute} bin_providers
:canonical: archivebox.api.v1_machine.MachineFilterSchema.bin_providers
:type: typing.Annotated[str | None, FilterLookup('bin_providers__icontains')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.MachineFilterSchema.bin_providers
```

````


:canonical: archivebox.api.v1_machine.BinarySchema

Bases: {py:obj}`ninja.Schema`

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.__init__
```

````{py:attribute} TYPE
:canonical: archivebox.api.v1_machine.BinarySchema.TYPE
:type: str
:value: >
   'machine.Binary'

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.TYPE
```

````

````{py:attribute} id
:canonical: archivebox.api.v1_machine.BinarySchema.id
:type: uuid.UUID
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.id
```

````

````{py:attribute} created_at
:canonical: archivebox.api.v1_machine.BinarySchema.created_at
:type: datetime.datetime
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.created_at
```

````

````{py:attribute} modified_at
:canonical: archivebox.api.v1_machine.BinarySchema.modified_at
:type: datetime.datetime
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.modified_at
```

````

````{py:attribute} machine_id
:canonical: archivebox.api.v1_machine.BinarySchema.machine_id
:type: uuid.UUID
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.machine_id
```

````

````{py:attribute} machine_hostname
:canonical: archivebox.api.v1_machine.BinarySchema.machine_hostname
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.machine_hostname
```

````

````{py:attribute} name
:canonical: archivebox.api.v1_machine.BinarySchema.name
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.name
```

````

````{py:attribute} binproviders
:canonical: archivebox.api.v1_machine.BinarySchema.binproviders
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.binproviders
```

````

````{py:attribute} binprovider
:canonical: archivebox.api.v1_machine.BinarySchema.binprovider
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.binprovider
```

````

````{py:attribute} abspath
:canonical: archivebox.api.v1_machine.BinarySchema.abspath
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.abspath
```

````

````{py:attribute} version
:canonical: archivebox.api.v1_machine.BinarySchema.version
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.version
```

````

````{py:attribute} sha256
:canonical: archivebox.api.v1_machine.BinarySchema.sha256
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.sha256
```

````

````{py:attribute} status
:canonical: archivebox.api.v1_machine.BinarySchema.status
:type: str
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.status
```

````

````{py:attribute} is_valid
:canonical: archivebox.api.v1_machine.BinarySchema.is_valid
:type: bool
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.is_valid
```

````

````{py:attribute} num_uses_succeeded
:canonical: archivebox.api.v1_machine.BinarySchema.num_uses_succeeded
:type: int
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.num_uses_succeeded
```

````

````{py:attribute} num_uses_failed
:canonical: archivebox.api.v1_machine.BinarySchema.num_uses_failed
:type: int
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.num_uses_failed
```

````

````{py:method} resolve_machine_hostname(obj) -> str
:canonical: archivebox.api.v1_machine.BinarySchema.resolve_machine_hostname
:staticmethod:

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.resolve_machine_hostname
```

````

````{py:method} resolve_is_valid(obj) -> bool
:canonical: archivebox.api.v1_machine.BinarySchema.resolve_is_valid
:staticmethod:

```{autodoc2-docstring} archivebox.api.v1_machine.BinarySchema.resolve_is_valid
```

````


:canonical: archivebox.api.v1_machine.BinaryFilterSchema

Bases: {py:obj}`ninja.FilterSchema`

````{py:attribute} id
:canonical: archivebox.api.v1_machine.BinaryFilterSchema.id
:type: typing.Annotated[str | None, FilterLookup('id__startswith')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinaryFilterSchema.id
```

````

````{py:attribute} name
:canonical: archivebox.api.v1_machine.BinaryFilterSchema.name
:type: typing.Annotated[str | None, FilterLookup('name__icontains')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinaryFilterSchema.name
```

````

````{py:attribute} binprovider
:canonical: archivebox.api.v1_machine.BinaryFilterSchema.binprovider
:type: typing.Annotated[str | None, FilterLookup('binprovider')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinaryFilterSchema.binprovider
```

````

````{py:attribute} status
:canonical: archivebox.api.v1_machine.BinaryFilterSchema.status
:type: typing.Annotated[str | None, FilterLookup('status')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinaryFilterSchema.status
```

````

````{py:attribute} machine_id
:canonical: archivebox.api.v1_machine.BinaryFilterSchema.machine_id
:type: typing.Annotated[str | None, FilterLookup('machine_id__startswith')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinaryFilterSchema.machine_id
```

````

````{py:attribute} version
:canonical: archivebox.api.v1_machine.BinaryFilterSchema.version
:type: typing.Annotated[str | None, FilterLookup('version__icontains')]
:value: >
   None

```{autodoc2-docstring} archivebox.api.v1_machine.BinaryFilterSchema.version
```

````


:canonical: archivebox.api.v1_machine.get_machines

```{autodoc2-docstring} archivebox.api.v1_machine.get_machines
```

:canonical: archivebox.api.v1_machine.get_current_machine

```{autodoc2-docstring} archivebox.api.v1_machine.get_current_machine
```

:canonical: archivebox.api.v1_machine.get_machine

```{autodoc2-docstring} archivebox.api.v1_machine.get_machine
```

:canonical: archivebox.api.v1_machine.get_binaries

```{autodoc2-docstring} archivebox.api.v1_machine.get_binaries
```

:canonical: archivebox.api.v1_machine.get_binary

```{autodoc2-docstring} archivebox.api.v1_machine.get_binary
```

:canonical: archivebox.api.v1_machine.get_binaries_by_name

```{autodoc2-docstring} archivebox.api.v1_machine.get_binaries_by_name
```