Sign in
bus

Prune contract data

Pruning a contract means that we compare the contract's sectors on the host with the contract's sectors in the database. Every sector in the contract that is not accounted for in our database will be pruned and thus deleted from the contract on the host side. This effectively removes the data from the network.

post/bus/contract/{id}/prune

Path parameters

idstring required

A unique identifier for a file contract

Request body

timeoutinteger

A duration in milliseconds

Example request

{
  "timeout": 30000
}

Response

Contract pruned successfully

sizeinteger

The size of the pruned contract in bytes

prunedinteger

The number of bytes pruned

remaininginteger

The number of prunable bytes remaining

errorstring

An error message if the prune failed

Changes

Changed in 3 of the 50 revisions of this API.22