IPFS · Schema

Failure

Response for a failed request

IPFSDistributed StorageContent-AddressedDecentralizedPeer-to-PeerFile StorageDAGPinningGateway

Properties

Name Type Description
error object
View JSON Schema on GitHub

JSON Schema

failure.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://ipfs.tech/schemas/pinning/failure",
  "title": "Failure",
  "description": "Response for a failed request",
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "required": [
        "reason"
      ],
      "properties": {
        "reason": {
          "type": "string",
          "description": "Mandatory string identifying the type of error",
          "example": "ERROR_CODE_FOR_MACHINES"
        },
        "details": {
          "type": "string",
          "description": "Optional, longer description of the error; may include UUID of transaction for support, links to documentation etc",
          "example": "Optional explanation for humans with more details"
        }
      }
    }
  }
}