---
title: "Scan host"
method: POST
path: "/bus/host/{hostkey}/scan"
tags: ["bus"]
---

# Scan host

`POST /bus/host/{hostkey}/scan`

Performs a scan of the host to check its settings and availability

## Path parameters

- `hostkey` string, required — A ed25519 public key

## Request body

- object
  - `timeout` integer — Scan timeout in milliseconds

## Response `200`

Host scan results

- object
  - `ping` integer — Round trip time in milliseconds
  - `scanError` string
  - `v2Settings` HostV2Settings
    - `protocolVersion` integer[] — Represents a semantic version as an array of three unsigned 8-bit integers: [major, minor, patch]
    - `release` string — Release tag of the host software
    - `walletAddress` string — The hash of a set of UnlockConditions
    - `acceptingContracts` boolean — Whether the host is accepting new contracts
    - `maxCollateral` string — An unsigned amount of Hastings, the smallest unit of currency in Sia. 1 Siacoin (SC) equals 10^24 Hastings (H).
    - `maxContractDuration` integer — Maximum allowed contract duration
    - `remainingStorage` integer — Amount of storage the host has remaining
    - `totalStorage` integer — Total amount of storage space
    - `prices` HostPrices
      - `contractPrice` string — Cost to the renter for forming, renewing, or refreshing a contract. Paid up front and covers the cost of the revision and storage proof transaction the host broadcasts at the end of the contract.
      - `collateral` string — The amount of Hastings the host will risk per byte of storage per block.
      - `storagePrice` string — Cost per byte of storage per block.
      - `ingressPrice` string — Cost per byte of data uploaded from the host
      - `egressPrice` string — Cost per byte of data downloaded from the host
      - `tipHeight` integer — The height at which the prices were last updated
      - `validUntil` string, date-time — The time at which these prices will no longer be honored by the host.
      - `signature` string, byte — A ed25519 signature

## Other responses

- `500` — Internal server error
- `503` — Not connected to peers

## Changes

- **2025-07-03** `472331be123c` — 2 warning
  - removed the optional property `priceTable` from the response with the `200` status
  - removed the optional property `settings` from the response with the `200` status
- **2025-03-13** `c878f2715ffd` — 10 breaking, 10 info
  - the `v2Settings/prices/collateral` response property's maxLength was unset from `39` for the response status `200`
  - the `v2Settings/prices/contractPrice` response property's maxLength was unset from `39` for the response status `200`
  - the `v2Settings/prices/egressPrice` response property's maxLength was unset from `39` for the response status `200`
  - the `v2Settings/prices/ingressPrice` response property's maxLength was unset from `39` for the response status `200`
  - …16 more
- **2024-12-18** `922f156353c9` — 1 breaking, 1 info
  - removed the media type `text/plain` for the response with the status `500`
  - api tag `bus` added
- **2024-12-17** `c29740362267` — 1 breaking, 9 info
  - the `v2Settings` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `v2Settings/acceptingContracts` to the response with the `200` status
  - added the optional property `v2Settings/maxCollateral` to the response with the `200` status
  - added the optional property `v2Settings/maxContractDuration` to the response with the `200` status
  - …6 more
- **2024-12-17** `5357864b9cf0` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/siafoundation/apis/renterd-api/changes/bus/host/:hostkey/scan/post.md)

---

[API](https://skmtc.dev/siafoundation/apis/renterd-api.md) · [All operations](https://skmtc.dev/siafoundation/apis/renterd-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/siafoundation/renterd-api/revisions/184a3d5207da/schema)