準備

List all preparations

get
Responses
200
OK
application/json
get
GET /api/preparation HTTP/1.1
Host: localhost:9090
Accept: */*

[
  {
    "createdAt": "text",
    "dealConfig": {
      "autoCreateDeals": true,
      "dealAnnounceToIpni": true,
      "dealDuration": 1,
      "dealHttpHeaders": {},
      "dealKeepUnsealed": true,
      "dealPricePerDeal": 1,
      "dealPricePerGb": 1,
      "dealPricePerGbEpoch": 1,
      "dealProvider": "text",
      "dealStartDelay": 1,
      "dealTemplate": "text",
      "dealUrlTemplate": "text",
      "dealVerified": true
    },
    "dealTemplateId": 1,
    "deleteAfterExport": true,
    "id": 1,
    "maxSize": 1,
    "minPieceSize": 1,
    "name": "text",
    "noDag": true,
    "noInline": true,
    "outputStorages": [
      {
        "clientConfig": {
          "caCert": [
            "text"
          ],
          "clientCert": "text",
          "clientKey": "text",
          "connectTimeout": 1,
          "disableHttp2": true,
          "disableHttpKeepAlives": true,
          "expectContinueTimeout": 1,
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "insecureSkipVerify": true,
          "lowlevelRetries": 1,
          "noGzip": true,
          "retryBackoff": 1,
          "retryBackoffExponential": 1,
          "retryDelay": 1,
          "retryMaxCount": 1,
          "scanConcurrency": 1,
          "skipInaccessibleFile": true,
          "timeout": 1,
          "useServerModTime": true,
          "userAgent": "text"
        },
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "createdAt": "text",
        "id": 1,
        "name": "text",
        "path": "text",
        "preparationsAsOutput": [
          {
            "createdAt": "text",
            "dealConfig": {
              "autoCreateDeals": true,
              "dealAnnounceToIpni": true,
              "dealDuration": 1,
              "dealHttpHeaders": {},
              "dealKeepUnsealed": true,
              "dealPricePerDeal": 1,
              "dealPricePerGb": 1,
              "dealPricePerGbEpoch": 1,
              "dealProvider": "text",
              "dealStartDelay": 1,
              "dealTemplate": "text",
              "dealUrlTemplate": "text",
              "dealVerified": true
            },
            "dealTemplateId": 1,
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "spValidation": true,
            "updatedAt": "text",
            "walletValidation": true
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "dealConfig": {
              "autoCreateDeals": true,
              "dealAnnounceToIpni": true,
              "dealDuration": 1,
              "dealHttpHeaders": {},
              "dealKeepUnsealed": true,
              "dealPricePerDeal": 1,
              "dealPricePerGb": 1,
              "dealPricePerGbEpoch": 1,
              "dealProvider": "text",
              "dealStartDelay": 1,
              "dealTemplate": "text",
              "dealUrlTemplate": "text",
              "dealVerified": true
            },
            "dealTemplateId": 1,
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "spValidation": true,
            "updatedAt": "text",
            "walletValidation": true
          }
        ],
        "type": "text",
        "updatedAt": "text"
      }
    ],
    "pieceSize": 1,
    "sourceStorages": [
      {
        "clientConfig": {
          "caCert": [
            "text"
          ],
          "clientCert": "text",
          "clientKey": "text",
          "connectTimeout": 1,
          "disableHttp2": true,
          "disableHttpKeepAlives": true,
          "expectContinueTimeout": 1,
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "insecureSkipVerify": true,
          "lowlevelRetries": 1,
          "noGzip": true,
          "retryBackoff": 1,
          "retryBackoffExponential": 1,
          "retryDelay": 1,
          "retryMaxCount": 1,
          "scanConcurrency": 1,
          "skipInaccessibleFile": true,
          "timeout": 1,
          "useServerModTime": true,
          "userAgent": "text"
        },
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "createdAt": "text",
        "id": 1,
        "name": "text",
        "path": "text",
        "preparationsAsOutput": [
          {
            "createdAt": "text",
            "dealConfig": {
              "autoCreateDeals": true,
              "dealAnnounceToIpni": true,
              "dealDuration": 1,
              "dealHttpHeaders": {},
              "dealKeepUnsealed": true,
              "dealPricePerDeal": 1,
              "dealPricePerGb": 1,
              "dealPricePerGbEpoch": 1,
              "dealProvider": "text",
              "dealStartDelay": 1,
              "dealTemplate": "text",
              "dealUrlTemplate": "text",
              "dealVerified": true
            },
            "dealTemplateId": 1,
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "spValidation": true,
            "updatedAt": "text",
            "walletValidation": true
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "dealConfig": {
              "autoCreateDeals": true,
              "dealAnnounceToIpni": true,
              "dealDuration": 1,
              "dealHttpHeaders": {},
              "dealKeepUnsealed": true,
              "dealPricePerDeal": 1,
              "dealPricePerGb": 1,
              "dealPricePerGbEpoch": 1,
              "dealProvider": "text",
              "dealStartDelay": 1,
              "dealTemplate": "text",
              "dealUrlTemplate": "text",
              "dealVerified": true
            },
            "dealTemplateId": 1,
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "spValidation": true,
            "updatedAt": "text",
            "walletValidation": true
          }
        ],
        "type": "text",
        "updatedAt": "text"
      }
    ],
    "spValidation": true,
    "updatedAt": "text",
    "walletValidation": true
  }
]

Create a new preparation

post
Body
autoCreateDealsbooleanOptional

Auto-deal creation parameters

Default: false
dealAnnounceToIpnibooleanOptional

Whether to announce to IPNI

Default: false
dealDurationintegerOptional

Deal duration

dealHttpHeadersall ofOptional

HTTP headers for deals

dealKeepUnsealedbooleanOptional

Whether to keep unsealed copy

Default: false
dealPricePerDealnumberOptional

Price in FIL per deal

Default: 0
dealPricePerGbnumberOptional

Price in FIL per GiB

Default: 0
dealPricePerGbEpochnumberOptional

Price in FIL per GiB per epoch

Default: 0
dealProviderstringOptional

Storage Provider ID

dealStartDelayintegerOptional

Deal start delay

dealTemplatestringOptional

Deal template name or ID to use (optional)

dealUrlTemplatestringOptional

URL template for deals

dealVerifiedbooleanOptional

Whether deals should be verified

Default: false
deleteAfterExportbooleanOptional

Whether to delete the source files after export

Default: false
maxSizestringOptional

Maximum size of the CAR files to be created

Default: 31.5GiB
minPieceSizestringOptional

Minimum piece size for the preparation, applies only to DAG and remainer pieces

Default: 1MiB
namestringRequired

Name of the preparation

noDagbooleanOptional

Whether to disable maintaining folder dag structure for the sources. If disabled, DagGen will not be possible and folders will not have an associated CID.

Default: false
noInlinebooleanOptional

Whether to disable inline storage for the preparation. Can save database space but requires at least one output storage.

Default: false
outputStoragesstring[]Optional

Name of Output storage systems to be used for the output

pieceSizestringOptional

Target piece size of the CAR files used for piece commitment calculation

sourceStoragesstring[]Optional

Name of Source storage systems to be used for the source

spValidationbooleanOptional

Enable storage provider validation

Default: false
walletValidationbooleanOptional

Enable wallet balance validation

Default: false
Responses
200
OK
application/json
post
POST /api/preparation HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 550

{
  "autoCreateDeals": false,
  "dealAnnounceToIpni": false,
  "dealDuration": 1,
  "dealHttpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "dealKeepUnsealed": false,
  "dealPricePerDeal": 0,
  "dealPricePerGb": 0,
  "dealPricePerGbEpoch": 0,
  "dealProvider": "text",
  "dealStartDelay": 1,
  "dealTemplate": "text",
  "dealUrlTemplate": "text",
  "dealVerified": false,
  "deleteAfterExport": false,
  "maxSize": "31.5GiB",
  "minPieceSize": "1MiB",
  "name": "text",
  "noDag": false,
  "noInline": false,
  "outputStorages": [
    "text"
  ],
  "pieceSize": "text",
  "sourceStorages": [
    "text"
  ],
  "spValidation": false,
  "walletValidation": false
}
{
  "createdAt": "text",
  "dealConfig": {
    "autoCreateDeals": true,
    "dealAnnounceToIpni": true,
    "dealDuration": 1,
    "dealHttpHeaders": {},
    "dealKeepUnsealed": true,
    "dealPricePerDeal": 1,
    "dealPricePerGb": 1,
    "dealPricePerGbEpoch": 1,
    "dealProvider": "text",
    "dealStartDelay": 1,
    "dealTemplate": "text",
    "dealUrlTemplate": "text",
    "dealVerified": true
  },
  "dealTemplateId": 1,
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "minPieceSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "pieceSize": 1,
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "spValidation": true,
  "updatedAt": "text",
  "walletValidation": true
}

Get the status of a preparation

get
Path parameters
idstringRequired

Preparation ID or name

Responses
200
OK
application/json
get
GET /api/preparation/{id} HTTP/1.1
Host: localhost:9090
Accept: */*

[
  {
    "attachmentId": 1,
    "jobs": [
      {
        "attachmentId": 1,
        "errorMessage": "text",
        "errorStackTrace": "text",
        "id": 1,
        "state": "created",
        "type": "scan",
        "workerId": "text"
      }
    ],
    "output": [
      {
        "clientConfig": {
          "caCert": [
            "text"
          ],
          "clientCert": "text",
          "clientKey": "text",
          "connectTimeout": 1,
          "disableHttp2": true,
          "disableHttpKeepAlives": true,
          "expectContinueTimeout": 1,
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "insecureSkipVerify": true,
          "lowlevelRetries": 1,
          "noGzip": true,
          "retryBackoff": 1,
          "retryBackoffExponential": 1,
          "retryDelay": 1,
          "retryMaxCount": 1,
          "scanConcurrency": 1,
          "skipInaccessibleFile": true,
          "timeout": 1,
          "useServerModTime": true,
          "userAgent": "text"
        },
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "createdAt": "text",
        "id": 1,
        "name": "text",
        "path": "text",
        "preparationsAsOutput": [
          {
            "createdAt": "text",
            "dealConfig": {
              "autoCreateDeals": true,
              "dealAnnounceToIpni": true,
              "dealDuration": 1,
              "dealHttpHeaders": {},
              "dealKeepUnsealed": true,
              "dealPricePerDeal": 1,
              "dealPricePerGb": 1,
              "dealPricePerGbEpoch": 1,
              "dealProvider": "text",
              "dealStartDelay": 1,
              "dealTemplate": "text",
              "dealUrlTemplate": "text",
              "dealVerified": true
            },
            "dealTemplateId": 1,
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "spValidation": true,
            "updatedAt": "text",
            "walletValidation": true
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "dealConfig": {
              "autoCreateDeals": true,
              "dealAnnounceToIpni": true,
              "dealDuration": 1,
              "dealHttpHeaders": {},
              "dealKeepUnsealed": true,
              "dealPricePerDeal": 1,
              "dealPricePerGb": 1,
              "dealPricePerGbEpoch": 1,
              "dealProvider": "text",
              "dealStartDelay": 1,
              "dealTemplate": "text",
              "dealUrlTemplate": "text",
              "dealVerified": true
            },
            "dealTemplateId": 1,
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "spValidation": true,
            "updatedAt": "text",
            "walletValidation": true
          }
        ],
        "type": "text",
        "updatedAt": "text"
      }
    ],
    "source": {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": "[Circular Reference]",
          "pieceSize": 1,
          "sourceStorages": "[Circular Reference]",
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": "[Circular Reference]",
          "pieceSize": 1,
          "sourceStorages": "[Circular Reference]",
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    },
    "storageId": 1
  }
]

Detach an output storage from a preparation

delete
Path parameters
idstringRequired

Preparation ID or name

namestringRequired

Output storage ID or name

Responses
200
OK
application/json
delete
DELETE /api/preparation/{id}/output/{name} HTTP/1.1
Host: localhost:9090
Accept: */*

{
  "createdAt": "text",
  "dealConfig": {
    "autoCreateDeals": true,
    "dealAnnounceToIpni": true,
    "dealDuration": 1,
    "dealHttpHeaders": {},
    "dealKeepUnsealed": true,
    "dealPricePerDeal": 1,
    "dealPricePerGb": 1,
    "dealPricePerGbEpoch": 1,
    "dealProvider": "text",
    "dealStartDelay": 1,
    "dealTemplate": "text",
    "dealUrlTemplate": "text",
    "dealVerified": true
  },
  "dealTemplateId": 1,
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "minPieceSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "pieceSize": 1,
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "spValidation": true,
  "updatedAt": "text",
  "walletValidation": true
}

Attach an output storage with a preparation

post
Path parameters
idstringRequired

Preparation ID or name

namestringRequired

Output storage ID or name

Responses
200
OK
application/json
post
POST /api/preparation/{id}/output/{name} HTTP/1.1
Host: localhost:9090
Accept: */*

{
  "createdAt": "text",
  "dealConfig": {
    "autoCreateDeals": true,
    "dealAnnounceToIpni": true,
    "dealDuration": 1,
    "dealHttpHeaders": {},
    "dealKeepUnsealed": true,
    "dealPricePerDeal": 1,
    "dealPricePerGb": 1,
    "dealPricePerGbEpoch": 1,
    "dealProvider": "text",
    "dealStartDelay": 1,
    "dealTemplate": "text",
    "dealUrlTemplate": "text",
    "dealVerified": true
  },
  "dealTemplateId": 1,
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "minPieceSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "pieceSize": 1,
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "spValidation": true,
  "updatedAt": "text",
  "walletValidation": true
}

Attach a source storage with a preparation

post
Path parameters
idstringRequired

Preparation ID or name

namestringRequired

Source storage ID or name

Responses
200
OK
application/json
post
POST /api/preparation/{id}/source/{name} HTTP/1.1
Host: localhost:9090
Accept: */*

{
  "createdAt": "text",
  "dealConfig": {
    "autoCreateDeals": true,
    "dealAnnounceToIpni": true,
    "dealDuration": 1,
    "dealHttpHeaders": {},
    "dealKeepUnsealed": true,
    "dealPricePerDeal": 1,
    "dealPricePerGb": 1,
    "dealPricePerGbEpoch": 1,
    "dealProvider": "text",
    "dealStartDelay": 1,
    "dealTemplate": "text",
    "dealUrlTemplate": "text",
    "dealVerified": true
  },
  "dealTemplateId": 1,
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "minPieceSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "pieceSize": 1,
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "dealConfig": {
            "autoCreateDeals": true,
            "dealAnnounceToIpni": true,
            "dealDuration": 1,
            "dealHttpHeaders": {},
            "dealKeepUnsealed": true,
            "dealPricePerDeal": 1,
            "dealPricePerGb": 1,
            "dealPricePerGbEpoch": 1,
            "dealProvider": "text",
            "dealStartDelay": 1,
            "dealTemplate": "text",
            "dealUrlTemplate": "text",
            "dealVerified": true
          },
          "dealTemplateId": 1,
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "spValidation": true,
          "updatedAt": "text",
          "walletValidation": true
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "spValidation": true,
  "updatedAt": "text",
  "walletValidation": true
}

Explore a directory in a prepared source storage

get
Path parameters
idstringRequired

Preparation ID or name

namestringRequired

Source storage ID or name

pathstringRequired

Directory path

Responses
200
OK
application/json
get
GET /api/preparation/{id}/source/{name}/explore/{path} HTTP/1.1
Host: localhost:9090
Accept: */*

{
  "cid": "text",
  "path": "text",
  "subEntries": [
    {
      "cid": "text",
      "fileVersions": [
        {
          "cid": "text",
          "hash": "text",
          "id": 1,
          "lastModified": "text",
          "size": 1
        }
      ],
      "isDir": true,
      "path": "text"
    }
  ]
}
PreviousピースNextストレージ

Last updated

Was this helpful?