✨
Singularity
日本語
日本語
  • 概要
    • Singularityとは何ですか
    • V1またはV2
  • インストール
    • バイナリのダウンロード
    • Dockerを使用してインストールする
    • ソースからビルドする
    • 本番環境への展開
  • データの準備
    • はじめに
    • パフォーマンスのチューニング
  • コンテンツの配布
    • CARファイルの配布
  • 取引の実施
    • 取引スケジュールの作成
  • トピック
    • インライン準備
    • ベンチマーク
  • 💻CLIリファレンス
    • メニュー
    • Ez Prep
    • バージョン
    • 管理者
      • 初期化
      • リセット
      • データセットの移行
      • スケジュールの移行
    • ダウンロード
    • CARの抽出
    • 取引
      • スケジュール
        • 作成
        • リスト
        • 更新
        • 一時停止
        • 再開
      • 手動送信
      • リスト
    • 実行
      • API
      • データセットワーカー
      • コンテンツプロバイダー
      • 取引トラッカー
      • 取引プッシャー
      • ダウンロードサーバー
    • ウォレット
      • インポート
      • リスト
      • 削除
    • ストレージ
      • 作成
        • 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
        • ローカル
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Opendrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • 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
          • 既存
          • 新規
        • Sugarsync
        • Swift
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • エクスプローラー
      • リスト
      • 削除
      • アップデート
        • 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
        • ローカル
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Opendrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • 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
          • 既存
          • 新規
        • Sugarsync
        • Swift
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • 名前変更
    • Prep
      • 作成
      • リスト
      • 状態
      • 名前変更
      • ソースの添付
      • 出力の添付
      • 出力の解除
      • スキャンの開始
      • スキャンの一時停止
      • パックの開始
      • パックの一時停止
      • Daggenの開始
      • Daggenの一時停止
      • ピースのリスト
      • ピースの追加
      • エクスプローラー
      • ウォレットの添付
      • ウォレットのリスト
      • ウォレットの解除
  • 🌐Web APIリファレンス
    • 取引スケジュール
    • 取引
    • ファイル
    • ジョブ
    • ピース
    • 準備
    • ストレージ
    • ウォレット関連
    • ウォレット
    • 仕様
  • ❓FAQ
    • データベースがロックされています
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Web APIリファレンス

準備

PreviousピースNextストレージ

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

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"
}