File

Get details about a file

get

Path parameters

idintegerRequired

File ID

Responses

200

OK

application/json

attachmentIdintegerOptional

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

cidstringOptional

CID is the CID of the file.

directoryIdintegerOptional

hashstringOptional

Hash is the hash of the file.

idintegerOptional

lastModifiedNanointegerOptional

pathstringOptional

Path is the relative path to the file inside the storage.

sizeintegerOptional

Size is the size of the file in bytes.

500

Internal Server Error

application/json

get

/file/{id}

HTTPcURLJavaScriptPython

GET /api/file/{id} HTTP/1.1
Accept: */*

{
  "attachmentId": 1,
  "cid": "text",
  "directoryId": 1,
  "fileRanges": [
    {
      "cid": "text",
      "fileId": 1,
      "id": 1,
      "jobId": 1,
      "length": 1,
      "offset": 1
    }
  ],
  "hash": "text",
  "id": 1,
  "lastModifiedNano": 1,
  "path": "text",
  "size": 1
}

Get all deals that have been made for a file

get

Path parameters

idintegerRequired

File ID

Responses

200

OK

application/json

500

Internal Server Error

application/json

get

/file/{id}/deals

HTTPcURLJavaScriptPython

GET /api/file/{id}/deals HTTP/1.1
Accept: */*

[
  {
    "deals": [
      {
        "clientId": "text",
        "createdAt": "text",
        "dealId": 1,
        "dealType": "market",
        "endEpoch": 1,
        "errorMessage": "text",
        "id": 1,
        "label": "text",
        "lastVerifiedAt": "text",
        "nextChallengeEpoch": 1,
        "pieceCid": "text",
        "pieceSize": 1,
        "price": "text",
        "proofSetId": 1,
        "proofSetLive": true,
        "proposalId": "text",
        "provider": "text",
        "scheduleId": 1,
        "sectorStartEpoch": 1,
        "startEpoch": 1,
        "state": "proposed",
        "updatedAt": "text",
        "verified": true,
        "walletId": 1
      }
    ],
    "fileRange": {
      "cid": "text",
      "fileId": 1,
      "id": 1,
      "jobId": 1,
      "length": 1,
      "offset": 1
    }
  }
]

prepare job for a given item

post

Path parameters

idintegerRequired

File ID

Responses

200

OK

application/json

integerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/file/{id}/prepare_to_pack

HTTPcURLJavaScriptPython

POST /api/file/{id}/prepare_to_pack HTTP/1.1
Accept: */*

1

Get content of a file

get

Path parameters

idintegerRequired

File ID

Header parameters

RangestringOptional

HTTP Range Header

Responses

200

OK

application/json

stringOptional

206

Partial Content

application/json

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/file/{id}/retrieve

HTTPcURLJavaScriptPython

GET /api/file/{id}/retrieve HTTP/1.1
Accept: */*

text

Push a file to be queued

post

Tells Singularity that something is ready to be grabbed for data preparation

Path parameters

idstringRequired

Preparation ID or name

namestringRequired

Source storage ID or name

Body

application/json

pathstringOptional

Path to the new file, relative to the source

Responses

200

OK

application/json

attachmentIdintegerOptional

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

cidstringOptional

CID is the CID of the file.

directoryIdintegerOptional

hashstringOptional

Hash is the hash of the file.

idintegerOptional

lastModifiedNanointegerOptional

pathstringOptional

Path is the relative path to the file inside the storage.

sizeintegerOptional

Size is the size of the file in bytes.

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/source/{name}/file

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/source/{name}/file HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "path": "text"
}

{
  "attachmentId": 1,
  "cid": "text",
  "directoryId": 1,
  "fileRanges": [
    {
      "cid": "text",
      "fileId": 1,
      "id": 1,
      "jobId": 1,
      "length": 1,
      "offset": 1
    }
  ],
  "hash": "text",
  "id": 1,
  "lastModifiedNano": 1,
  "path": "text",
  "size": 1
}