Add a file to IPFS

POST /ipfs/add

You need to /ipfs/pin/add an object to avoid it being garbage collected. This usage is being counted in your user account quota.

Hosted Endpoint only available for hosted variant.

Request

multipart/form-data

Body

file binary

Responses

• 200
• 400
• 403
• 404
• 418
• 429
• 500

---

Returns information about added IPFS object

application/json

Schema

Example (from schema)

---

Schema

name string required

Name of the file

ipfs_hash string required

IPFS hash of the file

size string required

IPFS node size in Bytes

{
  "name": "README.md",
  "ipfs_hash": "QmZbHqiCxKEVX7QfijzJTkZiSi3WEVTcvANgNAWzDYgZDr",
  "size": "125297"
}

Bad request

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 400,
  "error": "Bad Request",
  "message": "Backend did not understand your request."
}

Authentication secret is missing or invalid

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 403,
  "error": "Forbidden",
  "message": "Invalid project token."
}

Component not found

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 404,
  "error": "Not Found",
  "message": "The requested component has not been found."
}

IP has been auto-banned for extensive sending of requests after usage limit has been reached

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 418,
  "error": "Requested Banned",
  "message": "IP has been auto-banned for flooding."
}

Usage limit reached

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 429,
  "error": "Project Over Limit",
  "message": "Usage is over limit."
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 500,
  "error": "Internal Server Error",
  "message": "An unexpected response was received from the backend."
}

Loading...