作业

Pack a pack job into car files

post

Path parameters

idintegerRequired

Pack job ID

Responses

200

OK

application/json

attachmentIdintegerOptional

createdAtstringOptional

fileSizeintegerOptional

idintegerOptional

jobIdintegerOptional

minPieceSizePaddingintegerOptional

MinPieceSizePadding tracks virtual padding for inline mode only. Inline: stores padding amount, PieceReader serves zeros virtually. Non-inline: always 0, literal zeros are written to CAR file for Curio TreeD compatibility.

numOfFilesintegerOptional

pieceCidstringOptional

pieceSizeintegerOptional

pieceTypestringOptional

PieceType indicates whether this is a data piece or DAG piece

preparationIdintegerOptional

Association - SET NULL for fast prep deletion, async cleanup

rootCidstringOptional

storageIdintegerOptional

storagePathstringOptional

StoragePath is the path to the CAR file inside the storage. If the StorageID is nil but StoragePath is not empty, it means the CAR file is stored at the local absolute path.

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/job/{id}/pack

HTTPcURLJavaScriptPython

POST /api/job/{id}/pack HTTP/1.1
Accept: */*

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

prepare to pack a data source

post

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Storage ID or name

Responses

204

No Content

400

Bad Request

application/json

500

Internal Server Error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/finalize HTTP/1.1
Accept: */*

No content

Pause an ongoing DAG generation job

post

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Storage ID or name

Responses

200

OK

application/json

attachmentIdintegerOptional

errorMessagestringOptional

errorStackTracestringOptional

idintegerOptional

statestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

workerIdstringOptional

Associations - AttachmentID SET NULL for fast prep deletion, async cleanup

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}/pause-daggen

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/pause-daggen HTTP/1.1
Accept: */*

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Pause a specific packing job

post

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Storage ID or name

job_idintegerRequired

Pack Job ID

Responses

200

OK

application/json

attachmentIdintegerOptional

errorMessagestringOptional

errorStackTracestringOptional

idintegerOptional

statestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

workerIdstringOptional

Associations - AttachmentID SET NULL for fast prep deletion, async cleanup

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}/pause-pack/{job_id}

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/pause-pack/{job_id} HTTP/1.1
Accept: */*

[
  {
    "attachmentId": 1,
    "errorMessage": "text",
    "errorStackTrace": "text",
    "id": 1,
    "state": "created",
    "type": "scan",
    "workerId": "text"
  }
]

Pause an ongoing scanning job

post

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Storage ID or name

Responses

200

OK

application/json

attachmentIdintegerOptional

errorMessagestringOptional

errorStackTracestringOptional

idintegerOptional

statestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

workerIdstringOptional

Associations - AttachmentID SET NULL for fast prep deletion, async cleanup

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}/pause-scan

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/pause-scan HTTP/1.1
Accept: */*

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Start a new DAG generation job

post

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Storage ID or name

Responses

200

OK

application/json

attachmentIdintegerOptional

errorMessagestringOptional

errorStackTracestringOptional

idintegerOptional

statestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

workerIdstringOptional

Associations - AttachmentID SET NULL for fast prep deletion, async cleanup

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}/start-daggen

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/start-daggen HTTP/1.1
Accept: */*

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Start or restart a specific packing job

post

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Storage ID or name

job_idintegerRequired

Pack Job ID

Responses

200

OK

application/json

attachmentIdintegerOptional

errorMessagestringOptional

errorStackTracestringOptional

idintegerOptional

statestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

workerIdstringOptional

Associations - AttachmentID SET NULL for fast prep deletion, async cleanup

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}/start-pack/{job_id}

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/start-pack/{job_id} HTTP/1.1
Accept: */*

[
  {
    "attachmentId": 1,
    "errorMessage": "text",
    "errorStackTrace": "text",
    "id": 1,
    "state": "created",
    "type": "scan",
    "workerId": "text"
  }
]

Start a new scanning job

post

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Storage ID or name

Responses

200

OK

application/json

attachmentIdintegerOptional

errorMessagestringOptional

errorStackTracestringOptional

idintegerOptional

statestring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

workerIdstringOptional

Associations - AttachmentID SET NULL for fast prep deletion, async cleanup

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}/start-scan

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/start-scan HTTP/1.1
Accept: */*

{
  "attachmentId": 1,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 1,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}