Job

Pack a pack job into car files

post

Path parameters

idintegerRequired

Pack job ID

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

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

{
  "attachmentId": 1,
  "createdAt": "text",
  "fileSize": 1,
  "id": 1,
  "jobId": 1,
  "numOfFiles": 1,
  "pieceCid": "text",
  "pieceSize": 1,
  "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

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/finalize HTTP/1.1
Host: localhost:9090
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

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/pause-daggen HTTP/1.1
Host: localhost:9090
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

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/pause-pack/{job_id} HTTP/1.1
Host: localhost:9090
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

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/pause-scan HTTP/1.1
Host: localhost:9090
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

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/start-daggen HTTP/1.1
Host: localhost:9090
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

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/start-pack/{job_id} HTTP/1.1
Host: localhost:9090
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

400

Bad Request

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

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

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