Endpoint

/v1/files/locks/smb/share-mode/

GET

Return a list of all granted file locks that the specified machine owns.

Parameters

Name Description Required
owner_address IP Address of the client that owns the lock. No
after Return entries after the given key (keys are returned in the paging object) No
limit Return no more than this many entries; the system may choose a smaller limit. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_share_mode_grants",
  "type": "object",
  "properties": {
    "grants": {
      "type": "array",
      "items": {
        "description": "grants",
        "type": "object",
        "properties": {
          "file_id": {
            "description": "file_id",
            "type": "string"
          },
          "stream_id": {
            "description": "stream_id",
            "type": "string"
          },
          "snapshot_id": {
            "description": "The locked file's snapshot ID. Empty if the file is at the head version (not from a snapshot).",
            "type": "string"
          },
          "mode": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "API_SHARE_MODE_READ",
                "API_SHARE_MODE_WRITE",
                "API_SHARE_MODE_DELETE",
                "API_SHARE_MODE_EXCLUDE_READ",
                "API_SHARE_MODE_EXCLUDE_WRITE",
                "API_SHARE_MODE_EXCLUDE_DELETE"
              ],
              "description": "mode:\n * `API_SHARE_MODE_DELETE` - API_SHARE_MODE_DELETE,\n * `API_SHARE_MODE_EXCLUDE_DELETE` - API_SHARE_MODE_EXCLUDE_DELETE,\n * `API_SHARE_MODE_EXCLUDE_READ` - API_SHARE_MODE_EXCLUDE_READ,\n * `API_SHARE_MODE_EXCLUDE_WRITE` - API_SHARE_MODE_EXCLUDE_WRITE,\n * `API_SHARE_MODE_READ` - API_SHARE_MODE_READ,\n * `API_SHARE_MODE_WRITE` - API_SHARE_MODE_WRITE"
            }
          },
          "owner_id": {
            "description": "The unique identifier for the process that owns the file lock.",
            "type": "string"
          },
          "owner_address": {
            "description": "The IP address to use for acquiring the file lock.",
            "type": "string"
          },
          "node_address": {
            "description": "The IP address of the node that receives the request.",
            "type": "string"
          }
        }
      }
    }
  }
}