준비 작업

List all preparations

get

Responses

200

OK

application/json

createdAtstringOptional

deleteAfterExportbooleanOptional

DeleteAfterExport is a flag that indicates whether the source files should be deleted after export.

idintegerOptional

maxSizeintegerOptional

minPieceSizeintegerOptional

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

namestringOptional

noDagbooleanOptional

noInlinebooleanOptional

pieceSizeintegerOptional

updatedAtstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/preparation

HTTPcURLJavaScriptPython

GET /api/preparation HTTP/1.1
Accept: */*

[
  {
    "createdAt": "text",
    "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",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "updatedAt": "text"
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "updatedAt": "text"
          }
        ],
        "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",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "updatedAt": "text"
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "updatedAt": "text"
          }
        ],
        "type": "text",
        "updatedAt": "text"
      }
    ],
    "updatedAt": "text"
  }
]

Create a new preparation

post

Body

application/json

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

Responses

200

OK

application/json

createdAtstringOptional

deleteAfterExportbooleanOptional

DeleteAfterExport is a flag that indicates whether the source files should be deleted after export.

idintegerOptional

maxSizeintegerOptional

minPieceSizeintegerOptional

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

namestringOptional

noDagbooleanOptional

noInlinebooleanOptional

pieceSizeintegerOptional

updatedAtstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation

HTTPcURLJavaScriptPython

POST /api/preparation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "deleteAfterExport": false,
  "maxSize": "31.5GiB",
  "minPieceSize": "1MiB",
  "name": "text",
  "noDag": false,
  "noInline": false,
  "outputStorages": [
    "text"
  ],
  "pieceSize": "text",
  "sourceStorages": [
    "text"
  ]
}

{
  "createdAt": "text",
  "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

Get the status of a preparation

get

Path parameters

idstringRequired

Preparation ID or name

Responses

200

OK

application/json

attachmentIdintegerOptional

storageIdintegerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/preparation/{id}

HTTPcURLJavaScriptPython

GET /api/preparation/{id} HTTP/1.1
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",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "updatedAt": "text"
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "minPieceSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "outputStorages": "[Circular Reference]",
            "pieceSize": 1,
            "sourceStorages": "[Circular Reference]",
            "updatedAt": "text"
          }
        ],
        "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": "[Circular Reference]",
          "pieceSize": 1,
          "sourceStorages": "[Circular Reference]",
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": "[Circular Reference]",
          "pieceSize": 1,
          "sourceStorages": "[Circular Reference]",
          "updatedAt": "text"
        }
      ],
      "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

createdAtstringOptional

deleteAfterExportbooleanOptional

DeleteAfterExport is a flag that indicates whether the source files should be deleted after export.

idintegerOptional

maxSizeintegerOptional

minPieceSizeintegerOptional

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

namestringOptional

noDagbooleanOptional

noInlinebooleanOptional

pieceSizeintegerOptional

updatedAtstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

delete

/preparation/{id}/output/{name}

HTTPcURLJavaScriptPython

DELETE /api/preparation/{id}/output/{name} HTTP/1.1
Accept: */*

{
  "createdAt": "text",
  "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

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

createdAtstringOptional

deleteAfterExportbooleanOptional

DeleteAfterExport is a flag that indicates whether the source files should be deleted after export.

idintegerOptional

maxSizeintegerOptional

minPieceSizeintegerOptional

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

namestringOptional

noDagbooleanOptional

noInlinebooleanOptional

pieceSizeintegerOptional

updatedAtstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/output/{name}

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/output/{name} HTTP/1.1
Accept: */*

{
  "createdAt": "text",
  "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

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

createdAtstringOptional

deleteAfterExportbooleanOptional

DeleteAfterExport is a flag that indicates whether the source files should be deleted after export.

idintegerOptional

maxSizeintegerOptional

minPieceSizeintegerOptional

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

namestringOptional

noDagbooleanOptional

noInlinebooleanOptional

pieceSizeintegerOptional

updatedAtstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name} HTTP/1.1
Accept: */*

{
  "createdAt": "text",
  "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "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",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

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

cidstringOptional

pathstringOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/preparation/{id}/source/{name}/explore/{path}

HTTPcURLJavaScriptPython

GET /api/preparation/{id}/source/{name}/explore/{path} HTTP/1.1
Accept: */*

{
  "cid": "text",
  "path": "text",
  "subEntries": [
    {
      "cid": "text",
      "fileVersions": [
        {
          "cid": "text",
          "hash": "text",
          "id": 1,
          "lastModified": "text",
          "size": 1
        }
      ],
      "isDir": true,
      "path": "text"
    }
  ]
}