Apply Renter Config

API Endpoint

http://localhost:5001/api/v1/config/profile/apply

Input Arguments

ArgumentInput ValuesTypeDescriptionRequired?
argstorage-client
storage-host
stringApply the configurations for your BTFS node to enable renting features.Y
dry-runNoneN/AView the difference between old and new configs.N

Usage

// Apply the config. 

curl -X POST "http://localhost:5001/api/v1/config/profile/apply?arg=storage-client"


// Apply config and view the difference between old and new configs.

curl -X POST "http://localhost:5001/api/v1/config/profile/apply?arg=storage-client&dry-run"

Response

{
  "OldCfg": {
    "API": {
      "HTTPHeaders": {}
    },
    "Addresses": {
      "API": "/ip4/127.0.0.1/tcp/5001",
      "Announce": [
        "/ip4/67.164.115.223/tcp/4001"
      ],
      "Gateway": "/ip4/127.0.0.1/tcp/8080",
      "NoAnnounce": [],
      "RemoteAPI": "/ip4/127.0.0.1/tcp/5101",
      "Swarm": [
        "/ip4/0.0.0.0/tcp/4001",
        "/ip6/::/tcp/4001"
      ]
    },
    "Bootstrap": [
      "/ip4/54.213.128.120/tcp/4001/btfs/QmWm3vBCRuZcJMUT9jDZysoYBb66aokmSReX26UaMk8qq5",


..........

     
        "GracePeriod": "20s",
        "HighWater": 900,
        "LowWater": 600,
        "Type": "basic"
      },
      "DisableBandwidthMetrics": false,
      "DisableNatPortMap": false,
      "DisableRelay": false,
      "EnableAutoNATService": false,
      "EnableAutoRelay": false,
      "EnableRelayHop": false
    }
  }
}