{
  "opencollection": "1.0.0",
  "info": {
    "name": "IPFS RPC Add pins API",
    "version": "v0"
  },
  "items": [
    {
      "info": {
        "name": "pins",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List pin objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:5001/pins",
            "params": [
              {
                "name": "cid",
                "value": "Qm1,Qm2,bafy3",
                "type": "query",
                "description": "Return pin objects responsible for pinning the specified CID(s); be aware that using longer hash functions introduces further constraints on the number of CIDs that will fit under the limit of 2000 characters per URL  in browser contexts"
              },
              {
                "name": "name",
                "value": "PreciousData.pdf",
                "type": "query",
                "description": "Return pin objects with specified name (by default a case-sensitive, exact match)"
              },
              {
                "name": "match",
                "value": "exact",
                "type": "query",
                "description": "Customize the text matching strategy applied when the name filter is present; exact (the default) is a case-sensitive exact match, partial matches anywhere in the name, iexact and ipartial are case-insensitive versions of the exact and partial strategies"
              },
              {
                "name": "status",
                "value": "queued,pinning",
                "type": "query",
                "description": "Return pin objects for pins with the specified status (when missing, service should default to pinned only)"
              },
              {
                "name": "before",
                "value": "2020-07-27T17:32:28.276Z",
                "type": "query",
                "description": "Return results created (queued) before provided timestamp"
              },
              {
                "name": "after",
                "value": "2020-07-27T17:32:28.276Z",
                "type": "query",
                "description": "Return results created (queued) after provided timestamp"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Max records to return"
              },
              {
                "name": "meta",
                "value": "",
                "type": "query",
                "description": "Return pin objects that match specified metadata keys passed as a string representation of a JSON object; when implementing a client library, make sure the parameter is URL-encoded to ensure safe transport"
              }
            ]
          },
          "docs": "List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned"
        },
        {
          "info": {
            "name": "Add pin object",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:5001/pins",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a new pin object for the current access token"
        },
        {
          "info": {
            "name": "Get pin object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:5001/pins/:requestid",
            "params": [
              {
                "name": "requestid",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get a pin object and its status"
        },
        {
          "info": {
            "name": "Replace pin object",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:5001/pins/:requestid",
            "params": [
              {
                "name": "requestid",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins)"
        },
        {
          "info": {
            "name": "Remove pin object",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:5001/pins/:requestid",
            "params": [
              {
                "name": "requestid",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove a pin object"
        }
      ]
    }
  ],
  "bundled": true
}