Skip to content

client.firmware

Retrieve firmware inventory across the tenant and per-machine.

Property

client.firmware

Methods

  • get_all() -> FirmwareResults: list firmware records (tenant-wide summary, single response).
  • get(device_id: str) -> FirmwareResults: fetch firmware info for one device by ID.
  • firmwareInventoryByMachine() -> AssetHardwareFirmwareResults: per-machine firmware inventory in the response body.
  • firmwareInventoryByMachineFiles() -> AssetHardwareFirmwareResults: per-machine firmware inventory delivered as exported files. Recommended for larger tenants.

Notes

  • The *Files() variant uses the shared ViaFiles export path. Results from both variants share the same shape.
  • These endpoints are undocumented in the public Defender API surface; field stability is not guaranteed upstream.
  • All methods return lazy BaseResults subclasses.

See also

API

FirmwareResults 

FirmwareResults(
    endpoint: BaseEndpoint,
    params: dict[str, str],
    *,
    path: str | None = None,
    single: bool = False,
    files: bool = False,
    method: str = "GET",
    request_kwargs: dict[str, Any] | None = None,
    use_concurrent_skip_pagination: bool | None = None,
    skip_page_size: int | None = None,
    skip_max_concurrent: int | None = None,
)

Results from the /api/firmware endpoint.

AssetHardwareFirmwareResults 

AssetHardwareFirmwareResults(
    endpoint: BaseEndpoint,
    params: dict[str, str],
    *,
    path: str | None = None,
    single: bool = False,
    files: bool = False,
    method: str = "GET",
    request_kwargs: dict[str, Any] | None = None,
    use_concurrent_skip_pagination: bool | None = None,
    skip_page_size: int | None = None,
    skip_max_concurrent: int | None = None,
)

Results from the /api/machines/hardwareFirmwareInventoryByMachine/ endpoint.

FirmwareEndpoint 

FirmwareEndpoint(http: Client, auth: MSALAuth)

Endpoint for /api/firmware.

get_all 

get_all() -> FirmwareResults

Retrieves firmware information for devices.

Docs: Null (undocumented endpoint)

get 

get(device_id: str) -> FirmwareResults

Retrieves firmware information for a specific firmware by ID.

Docs: Null (undocumented endpoint)

firmwareInventoryByMachine 

firmwareInventoryByMachine() -> (
    AssetHardwareFirmwareResults
)

Get the firmware inventory for machines.

Docs: Null (undocumented endpoint)

firmwareInventoryByMachineFiles 

firmwareInventoryByMachineFiles() -> (
    AssetHardwareFirmwareResults
)

Get the firmware inventory for machines as files.

Same Results as firmwareInventoryByMachine but exported as a file instead of in the response body. Recommended for larger data sets, as it returns zipped files with the data instead of returning it in the response body.

Docs: Null (undocumented endpoint)