Preparation

List all preparations

GET//localhost:9090/api/preparation

Response

200400500

OK

Body

application/json

createdAtstring

deleteAfterExportboolean

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

idinteger

maxSizeinteger

namestring

noDagboolean

noInlineboolean

outputStoragesarray of model.Storage (object)

pieceSizeinteger

sourceStoragesarray of model.Storage (object)

updatedAtstring

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "createdAt": "text",
    "deleteAfterExport": false,
    "name": "text",
    "noDag": false,
    "noInline": false,
    "outputStorages": [
      {
        "clientConfig": {
          "caCert": [
            "text"
          ],
          "clientCert": "text",
          "clientKey": "text",
          "disableHttp2": false,
          "disableHttpKeepAlives": false,
          "insecureSkipVerify": false,
          "noGzip": false,
          "retryBackoffExponential": 0,
          "skipInaccessibleFile": false,
          "useServerModTime": false,
          "userAgent": "text"
        },
        "config": {},
        "createdAt": "text",
        "name": "text",
        "path": "text",
        "preparationsAsOutput": [],
        "preparationsAsSource": [],
        "type": "text",
        "updatedAt": "text"
      }
    ],
    "sourceStorages": [
      {
        "clientConfig": {
          "caCert": [
            "text"
          ],
          "clientCert": "text",
          "clientKey": "text",
          "disableHttp2": false,
          "disableHttpKeepAlives": false,
          "insecureSkipVerify": false,
          "noGzip": false,
          "retryBackoffExponential": 0,
          "skipInaccessibleFile": false,
          "useServerModTime": false,
          "userAgent": "text"
        },
        "config": {},
        "createdAt": "text",
        "name": "text",
        "path": "text",
        "preparationsAsOutput": [],
        "preparationsAsSource": [],
        "type": "text",
        "updatedAt": "text"
      }
    ],
    "updatedAt": "text"
  }
]

Create a new preparation

POST//localhost:9090/api/preparation

Body

application/json

Create Request

deleteAfterExportboolean

Whether to delete the source files after export

maxSizestring

Maximum size of the CAR files to be created

name*string

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.

outputStoragesarray of string

Name of Output storage systems to be used for the output

pieceSizestring

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

sourceStoragesarray of string

Name of Source storage systems to be used for the source

Response

200400500

OK

Body

application/json

createdAtstring

deleteAfterExportboolean

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

idinteger

maxSizeinteger

namestring

noDagboolean

noInlineboolean

outputStoragesarray of model.Storage (object)

pieceSizeinteger

sourceStoragesarray of model.Storage (object)

updatedAtstring

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "createdAt": "text",
  "deleteAfterExport": false,
  "name": "text",
  "noDag": false,
  "noInline": false,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

Get the status of a preparation

GET//localhost:9090/api/preparation/{id}

Path parameters

id*string

Preparation ID or name

Response

200400500

OK

Body

application/json

attachmentIdinteger

jobsarray of model.Job (object)

outputarray of model.Storage (object)

sourcemodel.Storage (object)

storageIdinteger

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "jobs": [
      {
        "errorMessage": "text",
        "errorStackTrace": "text",
        "state": "created",
        "type": "scan",
        "workerId": "text"
      }
    ],
    "output": [
      {
        "clientConfig": {
          "caCert": [
            "text"
          ],
          "clientCert": "text",
          "clientKey": "text",
          "disableHttp2": false,
          "disableHttpKeepAlives": false,
          "insecureSkipVerify": false,
          "noGzip": false,
          "retryBackoffExponential": 0,
          "skipInaccessibleFile": false,
          "useServerModTime": false,
          "userAgent": "text"
        },
        "config": {},
        "createdAt": "text",
        "name": "text",
        "path": "text",
        "preparationsAsOutput": [
          {
            "createdAt": "text",
            "deleteAfterExport": false,
            "name": "text",
            "noDag": false,
            "noInline": false,
            "outputStorages": [],
            "sourceStorages": [],
            "updatedAt": "text"
          }
        ],
        "preparationsAsSource": [
          {
            "createdAt": "text",
            "deleteAfterExport": false,
            "name": "text",
            "noDag": false,
            "noInline": false,
            "outputStorages": [],
            "sourceStorages": [],
            "updatedAt": "text"
          }
        ],
        "type": "text",
        "updatedAt": "text"
      }
    ],
    "source": {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": false,
          "name": "text",
          "noDag": false,
          "noInline": false,
          "outputStorages": [],
          "sourceStorages": [],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": false,
          "name": "text",
          "noDag": false,
          "noInline": false,
          "outputStorages": [],
          "sourceStorages": [],
          "updatedAt": "text"
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  }
]

Detach an output storage from a preparation

DELETE//localhost:9090/api/preparation/{id}/output/{name}

Path parameters

id*string

Preparation ID or name

name*string

Output storage ID or name

Response

200400500

OK

Body

application/json

createdAtstring

deleteAfterExportboolean

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

idinteger

maxSizeinteger

namestring

noDagboolean

noInlineboolean

outputStoragesarray of model.Storage (object)

pieceSizeinteger

sourceStoragesarray of model.Storage (object)

updatedAtstring

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation/{id}/output/{name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "createdAt": "text",
  "deleteAfterExport": false,
  "name": "text",
  "noDag": false,
  "noInline": false,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

Attach an output storage with a preparation

POST//localhost:9090/api/preparation/{id}/output/{name}

Path parameters

id*string

Preparation ID or name

name*string

Output storage ID or name

Response

200400500

OK

Body

application/json

createdAtstring

deleteAfterExportboolean

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

idinteger

maxSizeinteger

namestring

noDagboolean

noInlineboolean

outputStoragesarray of model.Storage (object)

pieceSizeinteger

sourceStoragesarray of model.Storage (object)

updatedAtstring

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation/{id}/output/{name}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "createdAt": "text",
  "deleteAfterExport": false,
  "name": "text",
  "noDag": false,
  "noInline": false,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

Attach a source storage with a preparation

POST//localhost:9090/api/preparation/{id}/source/{name}

Path parameters

id*string

Preparation ID or name

name*string

Source storage ID or name

Response

200400500

OK

Body

application/json

createdAtstring

deleteAfterExportboolean

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

idinteger

maxSizeinteger

namestring

noDagboolean

noInlineboolean

outputStoragesarray of model.Storage (object)

pieceSizeinteger

sourceStoragesarray of model.Storage (object)

updatedAtstring

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "createdAt": "text",
  "deleteAfterExport": false,
  "name": "text",
  "noDag": false,
  "noInline": false,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}

Explore a directory in a prepared source storage

GET//localhost:9090/api/preparation/{id}/source/{name}/explore/{path}

Path parameters

id*string

Preparation ID or name

name*string

Source storage ID or name

path*string

Directory path

Response

200400500

OK

Body

application/json

cidstring

pathstring

subEntriesarray of dataprep.DirEntry (object)

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/explore/{path}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "cid": "text",
  "path": "text",
  "subEntries": [
    {
      "cid": "text",
      "fileVersions": [
        {
          "cid": "text",
          "hash": "text",
          "lastModified": "text"
        }
      ],
      "isDir": false,
      "path": "text"
    }
  ]
}

Remove a preparation

DELETE//localhost:9090/api/preparation/{name}

Path parameters

name*string

Preparation ID or name

Body

application/json

Remove Request

removeCarsboolean

Response

204400500

No Content

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation/{name}', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Rename a preparation

PATCH//localhost:9090/api/preparation/{name}/rename

Path parameters

name*string

Preparation ID or name

Body

application/json

New preparation name

name*string

Response

200400500

OK

Body

application/json

createdAtstring

deleteAfterExportboolean

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

idinteger

maxSizeinteger

namestring

noDagboolean

noInlineboolean

outputStoragesarray of model.Storage (object)

pieceSizeinteger

sourceStoragesarray of model.Storage (object)

updatedAtstring

Request

JavaScriptCurl

const response = await fetch('//localhost:9090/api/preparation/{name}/rename', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "createdAt": "text",
  "deleteAfterExport": false,
  "name": "text",
  "noDag": false,
  "noInline": false,
  "outputStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "sourceStorages": [
    {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "disableHttp2": false,
        "disableHttpKeepAlives": false,
        "insecureSkipVerify": false,
        "noGzip": false,
        "retryBackoffExponential": 0,
        "skipInaccessibleFile": false,
        "useServerModTime": false,
        "userAgent": "text"
      },
      "config": {},
      "createdAt": "text",
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [],
      "preparationsAsSource": [],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text"
}