Endpoint

/v1/files/try-resolve

POST

Attempt to return the full path for each specified file ID, grouped by outcome: success with path, file deleted, file temporarily unavailable. Resolution for a temporarily unavailable file should be attempted again later. If a file has more than one path (due to hard links) a canonical path is chosen.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "fs_api_try_resolve_request",
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "description": "File IDs to resolve",
        "type": "string"
      }
    },
    "snapshot": {
      "description": "Snapshot to resolve against. Defaults to the live filesystem.",
      "type": "number"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "fs_api_try_resolve_result",
  "type": "object",
  "properties": {
    "available": {
      "type": "array",
      "items": {
        "description": "Full path of each file or directory whose path was resolved",
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique ID of this file or directory",
            "type": "string"
          },
          "path": {
            "description": "Full path of this file or directory",
            "type": "string"
          }
        }
      }
    },
    "unavailable": {
      "type": "array",
      "items": {
        "description": "File IDs that are temporarily unavailable",
        "type": "string"
      }
    },
    "deleted": {
      "type": "array",
      "items": {
        "description": "File IDs that have been deleted",
        "type": "string"
      }
    }
  }
}