Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
authentication
1
autopilot
3
bus
103
get
/bus/accounts
Get all accounts
post
/bus/accounts
Save accounts
post
/bus/accounts/fund
Fund an account
get
/bus/alerts
Get all alerts
post
/bus/alerts/dismiss
Dismiss alerts
post
/bus/alerts/register
Register an alert
get
/bus/autopilot
Get autopilot configuration
put
/bus/autopilot
Update autopilot configuration
get
/bus/buckets
Get all buckets
post
/bus/buckets
Create bucket
put
/bus/bucket/{name}/policy
Update bucket policy
get
/bus/bucket/{name}
Get bucket
delete
/bus/bucket/{name}
Delete bucket
post
/bus/consensus/acceptblock
Accept block
get
/bus/consensus/network
Get network details
get
/bus/consensus/siafundfee/{payout}
Get siafund fee
get
/bus/consensus/state
Get consensus state
get
/bus/contracts
Get all contracts
put
/bus/contracts
Update a contract
delete
/bus/contracts/all
Archives all contracts
post
/bus/contracts/archive
Archive contracts
post
/bus/contracts/form
Form a new contract
get
/bus/contracts/prunable
Get prunable contract data
get
/bus/contracts/renewed/{id}
Get renewed contract
post
/bus/contracts/spending
Record contract spending
get
/bus/contract/{id}
Get contract by ID
delete
/bus/contract/{id}
Archive contract with archival reason 'removed'. Archiving a contract means that all the data that was stored in that contract has to be migrated.
post
/bus/contract/{id}/acquire
Acquire contract lock. This lock is used to prevent multiple operations on the same contract from happening at the same time. Usually any operation that requires an update to the contract's revision needs to acquire the lock.
get
/bus/contract/{id}/ancestors
Get contract ancestors. A contract's ancestors are the contracts that were formed before it. If a contract is renewed, the existing contract is considered an ancestor of the new contract.
post
/bus/contract/{id}/broadcast
Broadcast contract's revision
post
/bus/contract/{id}/keepalive
Keep contract lock alive
get
/bus/contract/{id}/revision
Get latest contract revision
post
/bus/contract/{id}/prune
Prune contract data
post
/bus/contract/{id}/renew
Renew contract
post
/bus/contract/{id}/release
Release contract lock
get
/bus/contract/{id}/roots
Get contract sector roots
get
/bus/contract/{id}/size
Get contract size
put
/bus/contract/{id}/usability
Update contract usability
get
/bus/hosts
Get usable hosts
post
/bus/hosts
Search hosts using filters
get
/bus/hosts/allowlist
Get host allowlist
put
/bus/hosts/allowlist
Update host allowlist
get
/bus/hosts/blocklist
Get host blocklist
put
/bus/hosts/blocklist
Update host blocklist
post
/bus/hosts/remove
Remove offline hosts
get
/bus/host/{hostkey}
Get host details
put
/bus/host/{hostkey}/check
Update host check
post
/bus/host/{hostkey}/resetlostsectors
Reset lost sectors
post
/bus/host/{hostkey}/scan
Scan host
get
/bus/metric/{key}
Get metrics
put
/bus/metric/{key}
Record metrics
delete
/bus/metric/{key}
Delete metrics
post
/bus/multipart/create
Create a multipart upload
post
/bus/multipart/abort
Abort a multipart upload
post
/bus/multipart/complete
Complete a multipart upload
put
/bus/multipart/part
Upload a part of a multipart upload
get
/bus/multipart/upload/{id}
Get multipart upload details
post
/bus/multipart/listuploads
List multipart uploads
post
/bus/multipart/listparts
List parts of a multipart upload
get
/bus/objects/{prefix}
List objects
post
/bus/objects/copy
Copy object
post
/bus/objects/remove
Remove objects by prefix
post
/bus/objects/rename
Rename objects
get
/bus/object/{key}
Get object
put
/bus/object/{key}
Store object
delete
/bus/object/{key}
Delete object
get
/bus/params/gouging
Get gouging parameters
get
/bus/params/upload
Get upload parameters
delete
/bus/sectors/{hostkey}/{root}
Delete host sector
get
/bus/settings/gouging
Get gouging settings
put
/bus/settings/gouging
Update gouging settings
get
/bus/settings/pinned
Get pinned settings
put
/bus/settings/pinned
Update pinned settings
get
/bus/settings/s3
Get S3 settings
put
/bus/settings/s3
Update S3 settings
get
/bus/settings/upload
Get upload settings
put
/bus/settings/upload
Update upload settings
get
/bus/slabbuffers
Get slab buffers info
post
/bus/slabbuffer/done
Mark packed slabs as uploaded
post
/bus/slabbuffer/fetch
Fetch packed slabs for upload
post
/bus/slabs/migration
Get slabs for migration
get
/bus/slabs/partial/{key}
Get partial slab
post
/bus/slabs/partial
Add partial slab
post
/bus/slabs/refreshhealth
Refresh slab health
get
/bus/slab/{key}
Get slab
put
/bus/slab/{key}
Update slab
get
/bus/syncer/address
Get the syncer's address
post
/bus/syncer/connect
Connect to a syncer
get
/bus/syncer/peers
Get syncer peers
post
/bus/system/sqlite3/backup
Backup SQLite database
get
/bus/state
Get bus state
get
/bus/stats/objects
Get object statistics
get
/bus/txpool/recommendedfee
Get recommended fee
get
/bus/txpool/transactions
Get all transactions
post
/bus/txpool/broadcast
Broadcast transaction
post
/bus/upload/{id}
Track upload
delete
/bus/upload/{id}
Finish upload
post
/bus/upload/{id}/sector
Add sectors to upload
get
/bus/wallet
Get wallet information
get
/bus/wallet/events
Get wallet events
get
/bus/wallet/pending
Get unconfirmed events
post
/bus/wallet/redistribute
Redistribute wallet funds
post
/bus/wallet/send
Send siacoins
worker
13
bus
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get bus state
get
/bus/state
Dec 18, 2024
922f156353c9
Revision changes
info
api tag
bus
added
Dec 17, 2024
c47444f72328
Revision changes
info
endpoint added
Dec 9, 2024
f062c35d8f47
Revision changes
breaking
api path removed without deprecation