Deal Schedule

List all schedules for a preparation

get

Path parameters

idanyrequired

Preparation ID or name

Responses

application/json

object[]optional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/preparation/{id}/schedules HTTP/1.1
Host: localhost:9090
Accept: */*

[
  {
    "allowedPieceCids": [
      "text"
    ],
    "announceToIpni": true,
    "createdAt": "text",
    "duration": 1,
    "errorMessage": "text",
    "force": true,
    "httpHeaders": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "id": 1,
    "keepUnsealed": true,
    "maxPendingDealNumber": 1,
    "maxPendingDealSize": 1,
    "notes": "text",
    "preparationId": 1,
    "pricePerDeal": 1,
    "pricePerGb": 1,
    "pricePerGbEpoch": 1,
    "provider": "text",
    "scheduleCron": "text",
    "scheduleCronPerpetual": true,
    "scheduleDealNumber": 1,
    "scheduleDealSize": 1,
    "startDelay": 1,
    "state": "active",
    "totalDealNumber": 1,
    "totalDealSize": 1,
    "updatedAt": "text",
    "urlTemplate": "text",
    "verified": true
  }
]

List all deal making schedules

get

Responses

application/json

object[]optional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/schedule HTTP/1.1
Host: localhost:9090
Accept: */*

[
  {
    "allowedPieceCids": [
      "text"
    ],
    "announceToIpni": true,
    "createdAt": "text",
    "duration": 1,
    "errorMessage": "text",
    "force": true,
    "httpHeaders": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "id": 1,
    "keepUnsealed": true,
    "maxPendingDealNumber": 1,
    "maxPendingDealSize": 1,
    "notes": "text",
    "preparationId": 1,
    "pricePerDeal": 1,
    "pricePerGb": 1,
    "pricePerGbEpoch": 1,
    "provider": "text",
    "scheduleCron": "text",
    "scheduleCronPerpetual": true,
    "scheduleDealNumber": 1,
    "scheduleDealSize": 1,
    "startDelay": 1,
    "state": "active",
    "totalDealNumber": 1,
    "totalDealSize": 1,
    "updatedAt": "text",
    "urlTemplate": "text",
    "verified": true
  }
]

Create a new schedule

post

Create a new schedule

Body

allowedPieceCidsstring[]optional

Allowed piece CIDs in this schedule

durationstringoptional

Duration in epoch or in duration format, i.e. 1500000, 2400h

Default: 12840h

forcebooleanoptional

Force to send out deals regardless of replication restriction

httpHeadersstring[]optional

http headers to be passed with the request (i.e. key=value)

ipnibooleanoptional

Whether the deal should be IPNI

Default: true

keepUnsealedbooleanoptional

Whether the deal should be kept unsealed

Default: true

maxPendingDealNumberintegeroptional

Max pending deal number

maxPendingDealSizestringoptional

Max pending deal size in human readable format, i.e. 100 TiB

notesstringoptional

Notes

preparationstringoptional

Preparation ID or name

pricePerDealnumberoptional

Price in FIL per deal

Default: 0

pricePerGbnumberoptional

Price in FIL per GiB

Default: 0

pricePerGbEpochnumberoptional

Price in FIL per GiB per epoch

Default: 0

providerstringoptional

Provider

scheduleCronstringoptional

Schedule cron pattern

scheduleCronPerpetualbooleanoptional

Whether a cron schedule should run in definitely

scheduleDealNumberintegeroptional

Number of deals per scheduled time

scheduleDealSizestringoptional

Size of deals per schedule trigger in human readable format, i.e. 100 TiB

startDelaystringoptional

Deal start delay in epoch or in duration format, i.e. 1000, 72h

Default: 72h

totalDealNumberintegeroptional

Total number of deals

totalDealSizestringoptional

Total size of deals in human readable format, i.e. 100 TiB

urlTemplatestringoptional

URL template with PIECE_CID placeholder for boost to fetch the CAR file, i.e. http://127.0.0.1/piece/{PIECE_CID}.car

verifiedbooleanoptional

Whether the deal should be verified

Default: true

Responses

application/json

objectoptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/schedule HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 474

{
  "allowedPieceCids": [
    "text"
  ],
  "duration": "text",
  "force": true,
  "httpHeaders": [
    "text"
  ],
  "ipni": true,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": "text",
  "notes": "text",
  "preparation": "text",
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": "text",
  "startDelay": "text",
  "totalDealNumber": 1,
  "totalDealSize": "text",
  "urlTemplate": "text",
  "verified": true
}

{
  "allowedPieceCids": [
    "text"
  ],
  "announceToIpni": true,
  "createdAt": "text",
  "duration": 1,
  "errorMessage": "text",
  "force": true,
  "httpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": 1,
  "notes": "text",
  "preparationId": 1,
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": 1,
  "startDelay": 1,
  "state": "active",
  "totalDealNumber": 1,
  "totalDealSize": 1,
  "updatedAt": "text",
  "urlTemplate": "text",
  "verified": true
}

Delete a specific schedule

delete

Path parameters

idanyrequired

Schedule ID

Responses

application/json

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/schedule/{id} HTTP/1.1
Host: localhost:9090
Accept: */*

No Content

Update a schedule

patch

Update a schedule

Path parameters

idanyrequired

Schedule ID

Body

allowedPieceCidsstring[]optional

Allowed piece CIDs in this schedule

durationstringoptional

Duration in epoch or in duration format, i.e. 1500000, 2400h

Default: 12840h

forcebooleanoptional

Force to send out deals regardless of replication restriction

httpHeadersstring[]optional

http headers to be passed with the request (i.e. key=value)

ipnibooleanoptional

Whether the deal should be IPNI

Default: true

keepUnsealedbooleanoptional

Whether the deal should be kept unsealed

Default: true

maxPendingDealNumberintegeroptional

Max pending deal number

maxPendingDealSizestringoptional

Max pending deal size in human readable format, i.e. 100 TiB

notesstringoptional

Notes

pricePerDealnumberoptional

Price in FIL per deal

Default: 0

pricePerGbnumberoptional

Price in FIL per GiB

Default: 0

pricePerGbEpochnumberoptional

Price in FIL per GiB per epoch

Default: 0

scheduleCronstringoptional

Schedule cron pattern

scheduleCronPerpetualbooleanoptional

Whether a cron schedule should run in definitely

scheduleDealNumberintegeroptional

Number of deals per scheduled time

scheduleDealSizestringoptional

Size of deals per schedule trigger in human readable format, i.e. 100 TiB

startDelaystringoptional

Deal start delay in epoch or in duration format, i.e. 1000, 72h

Default: 72h

totalDealNumberintegeroptional

Total number of deals

totalDealSizestringoptional

Total size of deals in human readable format, i.e. 100 TiB

urlTemplatestringoptional

URL template with PIECE_CID placeholder for boost to fetch the CAR file, i.e. http://127.0.0.1/piece/{PIECE_CID}.car

verifiedbooleanoptional

Whether the deal should be verified

Default: true

Responses

application/json

objectoptional

application/json

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/schedule/{id} HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 435

{
  "allowedPieceCids": [
    "text"
  ],
  "duration": "text",
  "force": true,
  "httpHeaders": [
    "text"
  ],
  "ipni": true,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": "text",
  "notes": "text",
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": "text",
  "startDelay": "text",
  "totalDealNumber": 1,
  "totalDealSize": "text",
  "urlTemplate": "text",
  "verified": true
}

{
  "allowedPieceCids": [
    "text"
  ],
  "announceToIpni": true,
  "createdAt": "text",
  "duration": 1,
  "errorMessage": "text",
  "force": true,
  "httpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": 1,
  "notes": "text",
  "preparationId": 1,
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": 1,
  "startDelay": 1,
  "state": "active",
  "totalDealNumber": 1,
  "totalDealSize": 1,
  "updatedAt": "text",
  "urlTemplate": "text",
  "verified": true
}

Pause a specific schedule

post

Path parameters

idanyrequired

Schedule ID

Responses

application/json

objectoptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/schedule/{id}/pause HTTP/1.1
Host: localhost:9090
Accept: */*

{
  "allowedPieceCids": [
    "text"
  ],
  "announceToIpni": true,
  "createdAt": "text",
  "duration": 1,
  "errorMessage": "text",
  "force": true,
  "httpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": 1,
  "notes": "text",
  "preparationId": 1,
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": 1,
  "startDelay": 1,
  "state": "active",
  "totalDealNumber": 1,
  "totalDealSize": 1,
  "updatedAt": "text",
  "urlTemplate": "text",
  "verified": true
}

Resume a specific schedule

post

Path parameters

idanyrequired

Schedule ID

Responses

application/json

objectoptional

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/schedule/{id}/resume HTTP/1.1
Host: localhost:9090
Accept: */*

{
  "allowedPieceCids": [
    "text"
  ],
  "announceToIpni": true,
  "createdAt": "text",
  "duration": 1,
  "errorMessage": "text",
  "force": true,
  "httpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": 1,
  "notes": "text",
  "preparationId": 1,
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": 1,
  "startDelay": 1,
  "state": "active",
  "totalDealNumber": 1,
  "totalDealSize": 1,
  "updatedAt": "text",
  "urlTemplate": "text",
  "verified": true
}