Skip to content

Storage

As reddio user you are able to upload metadata, files are under project's scope.

Note: This function is still in Alpha and we do not guarantee any SLA, upload file size limit is 100MiB.

Upload file(s)

Uploading a single file is easy, just upload it!

If you'd like to upload a directory of files, you should convert them to CAR format using ipfs-car, it's quite simple, just follow the following steps.

npm install -g ipfs-car
ipfs-car --pack /path/to/your/directory_name

Then a directory_name.car will be created, you can now just upload this file.

Parameters


*file file

The file you with to upload.

jsx
POST /v1/project/<project_uuid>/storage

cURL Example

sh
curl -v -X POST -H 'x-api-key: rk-xxxxxx-4326-4b58-ae69-xxxxxxxx' -F "file=@directory_name.car" https://api-dev.reddio.com/v1/project/8e179868-c7ca-49bc-afd7-c178b7b8cf15/storage

Example response

json
{
    "status": "OK",
    "data": {
        "cid": "bafybeibs4sfygak2sfxxxxpytsuccmhjilcrwsmjus57ntxvyxxxxlpddq",
        "endpoints": [
            "https://bafybeibs4sfygak2sfxxxxpytsuccmhjilcrwsmjus57ntxvyxxxxlpddq.ipfs.nftstorage.link/"
        ]
    },
    "error": ""
}

Get uploaded files

List uploaded files under related project.

jsx
GET /v1/project/<project_uuid>/storage

Parameters

limit string

Limit entries for query records.


page string

Page for records.


cURL Example

sh
curl -v -H 'x-api-key: rk-xxxxxx-4326-4b58-ae69-xxxxxxxx' https://api-dev.reddio.com/v1/project/8e179868-c7ca-49bc-afd7-c178b7b8cf15/storage

Example response

json
{{
    "status": "OK",
    "data": {
        "storages": {
            "list": [
                {
                    "cid": "bafybeig7d7rshk2u7fch325hogssne3rs26o4qspli7ylrq7myzfc3i46u",
                    "filename": "c.jpg",
                    "filesize": "173604",
                    "created_at": "2023-02-09T03:36:48.000000Z",
                    "endpoints": [
                        "https://bafybeig7d7rshk2u7fch325hogssne3rs26o4qspli7ylrq7myzfc3i46u.ipfs.nftstorage.link/"
                    ]
                },
                {
                    "cid": "bafybeie43tseoyu6q35fb2gp4lugqsclxcyy357ghoajh5ojckhyie63ji",
                    "filename": "d.jpg",
                    "filesize": "173604",
                    "created_at": "2023-02-09T03:36:54.000000Z",
                    "endpoints": [
                        "https://bafybeie43tseoyu6q35fb2gp4lugqsclxcyy357ghoajh5ojckhyie63ji.ipfs.nftstorage.link/"
                    ]
                }
            ],
            "total": 5,
            "current_page": 2,
            "page_size": "2",
            "total_page": 3
        }
    },
    "error": ""
}

Remove uploaded files

Remove uploaded files by CID, please note that this will not actually delete uploaded files from the IPFS network.

jsx
POST /v1/project/<project_uuid>/storage/remove

Parameters


*cid string

CID of the file

Example payload

json
{
    "cid":"bafybeihfwm7c5n7ool3lhmsz52j5bbdmef4evin5zohkw7t6zy5gy6tk8u"
}

Example response

json
{
    "status": "OK",
    "data": "File removed.",
    "error": ""
}