Preparation

List all preparations

get

/preparation

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//localhost:9090/api/preparation'

200

400

500

200

[
  {
    "createdAt": "text",
    "deleteAfterExport": true,
    "id": 1,
    "maxSize": 1,
    "name": "text",
    "noDag": true,
    "noInline": true,
    "pieceSize": 1,
    "updatedAt": "text",
    "outputStorages": [
      {
        "createdAt": "text",
        "id": 1,
        "name": "text",
        "path": "text",
        "type": "text",
        "updatedAt": "text",
        "preparationsAsOutput": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "pieceSize": 1,
            "updatedAt": "text",
            "outputStorages": "[Circular Reference]",
            "sourceStorages": "[Circular Reference]"
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "pieceSize": 1,
            "updatedAt": "text",
            "outputStorages": "[Circular Reference]",
            "sourceStorages": "[Circular Reference]"
          }
        ],
        "clientConfig": {
          "clientCert": "text",
          "clientKey": "text",
          "connectTimeout": 1,
          "disableHttp2": true,
          "disableHttpKeepAlives": true,
          "expectContinueTimeout": 1,
          "insecureSkipVerify": true,
          "lowlevelRetries": 1,
          "noGzip": true,
          "retryBackoff": 1,
          "retryBackoffExponential": 1,
          "retryDelay": 1,
          "retryMaxCount": 1,
          "scanConcurrency": 1,
          "skipInaccessibleFile": true,
          "timeout": 1,
          "useServerModTime": true,
          "userAgent": "text",
          "caCert": [
            "text"
          ],
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "sourceStorages": [
      {
        "createdAt": "text",
        "id": 1,
        "name": "text",
        "path": "text",
        "type": "text",
        "updatedAt": "text",
        "preparationsAsOutput": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "pieceSize": 1,
            "updatedAt": "text",
            "outputStorages": "[Circular Reference]",
            "sourceStorages": "[Circular Reference]"
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "pieceSize": 1,
            "updatedAt": "text",
            "outputStorages": "[Circular Reference]",
            "sourceStorages": "[Circular Reference]"
          }
        ],
        "clientConfig": {
          "clientCert": "text",
          "clientKey": "text",
          "connectTimeout": 1,
          "disableHttp2": true,
          "disableHttpKeepAlives": true,
          "expectContinueTimeout": 1,
          "insecureSkipVerify": true,
          "lowlevelRetries": 1,
          "noGzip": true,
          "retryBackoff": 1,
          "retryBackoffExponential": 1,
          "retryDelay": 1,
          "retryMaxCount": 1,
          "scanConcurrency": 1,
          "skipInaccessibleFile": true,
          "timeout": 1,
          "useServerModTime": true,
          "userAgent": "text",
          "caCert": [
            "text"
          ],
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

OK

Create a new preparation

post

/preparation

Body

deleteAfterExportboolean

Whether to delete the source files after export

maxSizestring · default: 31.5GiB

Maximum size of the CAR files to be created

namestringrequired

Name of the preparation

noDagboolean

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.

noInlineboolean

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

pieceSizestring

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

outputStoragesstring[]

Name of Output storage systems to be used for the output

sourceStoragesstring[]

Name of Source storage systems to be used for the source

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation' \
  --header 'Content-Type: application/json' \
  --data '{"deleteAfterExport":false,"maxSize":"31.5GiB","name":"text","noDag":false,"noInline":false,"outputStorages":[null],"sourceStorages":[null]}'

200

400

500

200

{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "pieceSize": 1,
  "updatedAt": "text",
  "outputStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "sourceStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

OK

Get the status of a preparation

get

/preparation/{id}

Path parameters

idstringrequired

Preparation ID or name

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//localhost:9090/api/preparation/{id}'

200

400

500

200

[
  {
    "attachmentId": 1,
    "source": {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "storageId": 1,
    "jobs": [
      {
        "attachmentId": 1,
        "errorMessage": "text",
        "errorStackTrace": "text",
        "id": 1,
        "state": "created",
        "type": "scan",
        "workerId": "text"
      }
    ],
    "output": [
      {
        "createdAt": "text",
        "id": 1,
        "name": "text",
        "path": "text",
        "type": "text",
        "updatedAt": "text",
        "preparationsAsOutput": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "pieceSize": 1,
            "updatedAt": "text",
            "outputStorages": "[Circular Reference]",
            "sourceStorages": "[Circular Reference]"
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 1,
            "name": "text",
            "noDag": true,
            "noInline": true,
            "pieceSize": 1,
            "updatedAt": "text",
            "outputStorages": "[Circular Reference]",
            "sourceStorages": "[Circular Reference]"
          }
        ],
        "clientConfig": {
          "clientCert": "text",
          "clientKey": "text",
          "connectTimeout": 1,
          "disableHttp2": true,
          "disableHttpKeepAlives": true,
          "expectContinueTimeout": 1,
          "insecureSkipVerify": true,
          "lowlevelRetries": 1,
          "noGzip": true,
          "retryBackoff": 1,
          "retryBackoffExponential": 1,
          "retryDelay": 1,
          "retryMaxCount": 1,
          "scanConcurrency": 1,
          "skipInaccessibleFile": true,
          "timeout": 1,
          "useServerModTime": true,
          "userAgent": "text",
          "caCert": [
            "text"
          ],
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

OK

Detach an output storage from a preparation

delete

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

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Output storage ID or name

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//localhost:9090/api/preparation/{id}/output/{name}'

200

400

500

200

{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "pieceSize": 1,
  "updatedAt": "text",
  "outputStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "sourceStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

OK

Attach an output storage with a preparation

post

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

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Output storage ID or name

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/output/{name}'

200

400

500

200

{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "pieceSize": 1,
  "updatedAt": "text",
  "outputStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "sourceStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

OK

Attach a source storage with a preparation

post

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

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Source storage ID or name

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//localhost:9090/api/preparation/{id}/source/{name}'

200

400

500

200

{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "pieceSize": 1,
  "updatedAt": "text",
  "outputStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "sourceStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

OK

Explore a directory in a prepared source storage

get

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

Path parameters

idstringrequired

Preparation ID or name

namestringrequired

Source storage ID or name

pathstringrequired

Directory path

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '//localhost:9090/api/preparation/{id}/source/{name}/explore/{path}'

200

400

500

200

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

OK

Remove a preparation

delete

/preparation/{name}

Path parameters

namestringrequired

Preparation ID or name

Body

removeCarsboolean

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '//localhost:9090/api/preparation/{name}' \
  --header 'Content-Type: application/json'

204

400

500

204

No body

No Content

Rename a preparation

patch

/preparation/{name}/rename

Path parameters

namestringrequired

Preparation ID or name

Body

namestringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '//localhost:9090/api/preparation/{name}/rename' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

400

500

200

{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "name": "text",
  "noDag": true,
  "noInline": true,
  "pieceSize": 1,
  "updatedAt": "text",
  "outputStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "sourceStorages": [
    {
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "type": "text",
      "updatedAt": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "pieceSize": 1,
          "updatedAt": "text",
          "outputStorages": "[Circular Reference]",
          "sourceStorages": "[Circular Reference]"
        }
      ],
      "clientConfig": {
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text",
        "caCert": [
          "text"
        ],
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

OK