Piece

Get metadata for a piece

get

Get metadata for a piece for how it may be reassembled from the data source

Path parameters

idstringRequired

Piece CID

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/piece/{id}/metadata

HTTPcURLJavaScriptPython

GET /api/piece/{id}/metadata HTTP/1.1
Accept: */*

{}

List all prepared pieces for 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

/preparation/{id}/piece

HTTPcURLJavaScriptPython

GET /api/preparation/{id}/piece HTTP/1.1
Accept: */*

[
  {
    "attachmentId": 1,
    "pieces": [
      {
        "attachmentId": 1,
        "createdAt": "text",
        "fileSize": 1,
        "id": 1,
        "jobId": 1,
        "minPieceSizePadding": 1,
        "numOfFiles": 1,
        "pieceCid": "text",
        "pieceSize": 1,
        "pieceType": "text",
        "preparationId": 1,
        "rootCid": "text",
        "storageId": 1,
        "storagePath": "text"
      }
    ],
    "source": {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "type": "text",
      "updatedAt": "text"
    },
    "storageId": 1
  }
]

Add a piece to a preparation

post

Path parameters

idstringRequired

Preparation ID or name

Body

application/json

fileSizeintegerOptional

File size of the CAR file, this is required for boost online deal

pieceCidstringRequired

CID of the piece

pieceSizestringOptional

Size of the piece (required for external import, optional if piece exists in DB)

rootCidstringOptional

Root CID of the CAR file, used to populate the label field of storage deal

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/piece

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/piece HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "fileSize": 1,
  "pieceCid": "text",
  "pieceSize": "text",
  "rootCid": "text"
}

{
  "attachmentId": 1,
  "createdAt": "text",
  "fileSize": 1,
  "id": 1,
  "jobId": 1,
  "minPieceSizePadding": 1,
  "numOfFiles": 1,
  "pieceCid": "text",
  "pieceSize": 1,
  "pieceType": "text",
  "preparationId": 1,
  "rootCid": "text",
  "storageId": 1,
  "storagePath": "text"
}

Delete a piece from a preparation

delete

Deletes a piece (CAR) and its associated records. For data pieces, resets file ranges to allow re-packing. For DAG pieces, resets directory export flags for re-generation.

Path parameters

idstringRequired

Preparation ID or name

piece_cidstringRequired

Piece CID

Body

application/json

deleteCarbooleanOptional

Delete the physical CAR file from storage (default: true)

forcebooleanOptional

Delete even if deals reference this piece

Responses

204

No Content

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/preparation/{id}/piece/{piece_cid}

HTTPcURLJavaScriptPython

DELETE /api/preparation/{id}/piece/{piece_cid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "deleteCar": true,
  "force": true
}

No content