Pin an object

POST /ipfs/pin/add/:IPFS_path

Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.

Request

Path Parameters

IPFS_path string required

Responses

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

---

Returns pinned object

application/json

Schema

Example (from schema)

---

Schema

ipfs_hash string required

IPFS hash of the pinned object

state string required

Possible values: [queued|pinned|unpinned|failed|gc]

State of the pin action

{
  "ipfs_hash": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8",
  "state": "queued"
}

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."
}

Pin queue is currently full, not accepting new txs straight away

application/json

Schema

Example (from schema)

---

Schema

status_code integer required
error string required
message string required

{
  "status_code": 425,
  "error": "Pin Queue Full",
  "message": "Your pin queue is currently full, please try pinning again later."
}

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...