Wallet Association

List all wallets of a preparation.

get

Path parameters

idstringRequired

Preparation ID or name

Responses

200

OK

application/json

actorIdstringOptional

nullable, links to on-chain actor f0...

addressstringOptional

filecoin address (f1.../f3...)

idintegerOptional

keyPathstringOptional

absolute path to key file

keyStorestringOptional

local, yubikey, aws-kms, etc

namestringOptional

optional label

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/preparation/{id}/wallet

HTTPcURLJavaScriptPython

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

[
  {
    "actorId": "text",
    "address": "text",
    "id": 1,
    "keyPath": "text",
    "keyStore": "text",
    "name": "text"
  }
]

Detach a new wallet from a preparation

delete

Path parameters

idstringRequired

Preparation ID or name

walletstringRequired

Wallet Address

Responses

200

OK

application/json

createdAtstringOptional

deleteAfterExportbooleanOptional

DeleteAfterExport is a flag that indicates whether the source files should be deleted after export.

idintegerOptional

maxSizeintegerOptional

minPieceSizeintegerOptional

Minimum piece size for the preparation, applies only to DAG and remainder pieces

namestringOptional

noDagbooleanOptional

noInlinebooleanOptional

pieceSizeintegerOptional

updatedAtstringOptional

walletIdintegerOptional

Associations

400

Bad Request

application/json

500

Internal Server Error

application/json

delete

/preparation/{id}/wallet/{wallet}

HTTPcURLJavaScriptPython

DELETE /api/preparation/{id}/wallet/{wallet} HTTP/1.1
Accept: */*

{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "minPieceSize": 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,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text",
          "walletId": 1
        }
      ],
      "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",
          "walletId": 1
        }
      ],
      "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,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text",
          "walletId": 1
        }
      ],
      "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",
          "walletId": 1
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text",
  "walletId": 1
}

Attach a new wallet with a preparation

post

Path parameters

idstringRequired

Preparation ID or name

walletstringRequired

Wallet Address

Responses

200

OK

application/json

createdAtstringOptional

deleteAfterExportbooleanOptional

DeleteAfterExport is a flag that indicates whether the source files should be deleted after export.

idintegerOptional

maxSizeintegerOptional

minPieceSizeintegerOptional

Minimum piece size for the preparation, applies only to DAG and remainder pieces

namestringOptional

noDagbooleanOptional

noInlinebooleanOptional

pieceSizeintegerOptional

updatedAtstringOptional

walletIdintegerOptional

Associations

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/preparation/{id}/wallet/{wallet}

HTTPcURLJavaScriptPython

POST /api/preparation/{id}/wallet/{wallet} HTTP/1.1
Accept: */*

{
  "createdAt": "text",
  "deleteAfterExport": true,
  "id": 1,
  "maxSize": 1,
  "minPieceSize": 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,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text",
          "walletId": 1
        }
      ],
      "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",
          "walletId": 1
        }
      ],
      "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,
          "minPieceSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text",
          "walletId": 1
        }
      ],
      "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",
          "walletId": 1
        }
      ],
      "type": "text",
      "updatedAt": "text"
    }
  ],
  "updatedAt": "text",
  "walletId": 1
}