✨
Singularity
English
English
  • Overview
    • What is Singularity
    • V1 or V2
  • Installation
    • Download binaries
    • Install via docker
    • Built from source
    • Deploy to production
    • Version upgrade
  • Data Preparation
    • Get Started
    • Performance Tuning
  • Content Distribution
    • Distribute CAR files
  • Deal Making
    • Create a deal schedule
  • Topics
    • Inline Preparation
    • Benchmark
  • 💻CLI Reference
    • Menu
    • Ez Prep
    • Version
    • Admin
      • Init
      • Reset
      • Migrate Dataset
      • Migrate Schedule
    • Download
    • Extract Car
    • Deal
      • Schedule
        • Create
        • List
        • Update
        • Pause
        • Resume
        • Remove
      • Send Manual
      • List
    • Run
      • Api
      • Dataset Worker
      • Content Provider
      • Deal Tracker
      • Deal Pusher
      • Download Server
    • Wallet
      • Import
      • List
      • Remove
    • Storage
      • Create
        • Acd
        • Azureblob
        • B2
        • Box
        • Drive
        • Dropbox
        • Fichier
        • Filefabric
        • Ftp
        • Google Cloud Storage
        • Gphotos
        • Hdfs
        • Hidrive
        • Http
        • Internetarchive
        • Jottacloud
        • Koofr / Digi Storage
          • Digistorage
          • Koofr / Digi Storage
          • Other
        • Local
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • Opendrive
        • Pcloud
        • Premiumizeme
        • Putio
        • Qingstor
        • AWS S3 and compliant
          • Aws
          • Alibaba
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • Huaweiobs
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • Netease
          • Other
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • Tencentcos
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • Existing
          • New
        • Sugarsync
        • Swift
        • Union
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • Explore
      • List
      • Remove
      • Update
        • Acd
        • Azureblob
        • B2
        • Box
        • Drive
        • Dropbox
        • Fichier
        • Filefabric
        • Ftp
        • Google Cloud Storage
        • Gphotos
        • Hdfs
        • Hidrive
        • Http
        • Internetarchive
        • Jottacloud
        • Koofr / Digi Storage
          • Digistorage
          • Koofr / Digi Storage
          • Other
        • Local
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • Opendrive
        • Pcloud
        • Premiumizeme
        • Putio
        • Qingstor
        • AWS S3 and compliant
          • Aws
          • Alibaba
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • Huaweiobs
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • Netease
          • Other
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • Tencentcos
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • Existing
          • New
        • Sugarsync
        • Swift
        • Union
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • Rename
    • Prep
      • Create
      • List
      • Status
      • Rename
      • Attach Source
      • Attach Output
      • Detach Output
      • Start Scan
      • Pause Scan
      • Start Pack
      • Pause Pack
      • Start Daggen
      • Pause Daggen
      • List Pieces
      • Add Piece
      • Explore
      • Attach Wallet
      • List Wallets
      • Detach Wallet
      • Remove
  • 🌐Web API Reference
    • Admin
    • Deal Schedule
    • Deal
    • File
    • Job
    • Piece
    • Preparation
    • Storage
    • Wallet Association
    • Wallet
    • Specification
  • ❓FAQ
    • Database is locked
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Web API Reference

Preparation

PreviousPieceNextStorage

Last updated 1 year ago

Was this helpful?

🌐

Get the status of a preparation

get
Path parameters
idstringRequired

Preparation ID or name

Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
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",
            "deleteAfterExport": true,
            "id": 1,
            "maxSize": 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,
            "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,
          "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,
          "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
400
Bad Request
application/json
500
Internal Server Error
application/json
delete
DELETE /api/preparation/{id}/output/{name} HTTP/1.1
Host: localhost:9090
Accept: */*
{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 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,
          "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,
          "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,
          "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,
          "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
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /api/preparation/{id}/output/{name} HTTP/1.1
Host: localhost:9090
Accept: */*
{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 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,
          "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,
          "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,
          "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,
          "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
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /api/preparation/{id}/source/{name} HTTP/1.1
Host: localhost:9090
Accept: */*
{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 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,
          "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,
          "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,
          "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,
          "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
400
Bad Request
application/json
500
Internal Server Error
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"
    }
  ]
}
  • GETList all preparations
  • POSTCreate a new preparation
  • GETGet the status of a preparation
  • DELETEDetach an output storage from a preparation
  • POSTAttach an output storage with a preparation
  • POSTAttach a source storage with a preparation
  • GETExplore a directory in a prepared source storage
  • DELETERemove a preparation
  • PATCHRename a preparation

List all preparations

get
Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
get
GET /api/preparation HTTP/1.1
Host: localhost:9090
Accept: */*
[
  {
    "createdAt": "text",
    "deleteAfterExport": true,
    "id": 1,
    "maxSize": 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,
            "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,
            "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,
            "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,
            "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
deleteAfterExportbooleanOptional

Whether to delete the source files after export

Default: false
maxSizestringOptional

Maximum size of the CAR files to be created

Default: 31.5GiB
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
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /api/preparation HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 157

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

Remove a preparation

delete
Path parameters
namestringRequired

Preparation ID or name

Body
removeCarsbooleanOptional
Responses
204
No Content
400
Bad Request
application/json
500
Internal Server Error
application/json
delete
DELETE /api/preparation/{name} HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "removeCars": true
}

No content

Rename a preparation

patch
Path parameters
namestringRequired

Preparation ID or name

Body
namestringRequired
Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
patch
PATCH /api/preparation/{name}/rename HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 15

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