Locks

A Lock can be used by your custom-developed applications to implement file locking and concurrency features. These locks are advisory, meaning that while a lock can be created, it does not prevent other API requests from being processed concurrently. You are responsible for checking locks prior to accessing a file.

The lock feature is designed to emulate the locking functionality provided by WebDAV. For a deeper understanding of how the lock mechanism works, refer to the WebDAV specification, which outlines how these endpoints function.

Files.com's WebDAV offering and desktop app leverage this locking API to manage concurrent file operations, ensuring consistency when multiple users or systems interact with the same files. It is not used within the Files.com web interface.

The optional owner parameter is a descriptive label, not the lock creator or a grant of permission. It can be set when creating a lock; refreshing a lock or replacing its token preserves it.

To refresh only an existing lock or replace its token, send expected_token, token, and timeout to the create endpoint. Set token to expected_token to refresh, or to a different value to replace. The expected token must identify an existing, unexpired lock on that path, and the caller must have permission to modify it. The token check and update happen together; invalid replacement values leave the stored lock unchanged.

A missing, expired, or mismatched expected token returns processing-failure/resource-locked with data.lock_token containing an active token on that path, or an empty string when none exists. Omitting expected_token retains the existing acquire-or-refresh behavior. Shared locks retain their existing semantics.

Resource Schema

Required

Property	Description
path String	Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

Optional

Property	Description
timeout Int64	Lock timeout in seconds
recursive Bool	Does lock apply to subfolders?
owner String	Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
exclusive Bool	Is lock exclusive?
token String	Lock token. Use to release lock.
allow_access_by_any_user Bool	Can lock be modified by users other than its creator?
expected_token String	Require this existing, unexpired token before refreshing or replacing a lock. Set token to the same value to refresh, or a different value to replace.

Read Only

Property	Description
depth String
scope String
type String
user_id Int64	Lock creator user ID
username String	Lock creator username

Example Resource

resource "files_lock" "example_lock" {
  path                     = "locked_file"
  token                    = "17c54824e9931a4688ca032d03f6663c"
  allow_access_by_any_user = false
  exclusive                = false
  recursive                = true
  owner                    = "user"
  timeout                  = 1
}

Resource Import

This Resource supports importing using the following syntax:

Example Import Command

# Locks can be imported by specifying the path.
terraform import files_lock.example_lock path

Data Source Schema

Required

Property	Description
path String	Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

Read Only

Property	Description
timeout Int64	Lock timeout in seconds
depth String
recursive Bool	Does lock apply to subfolders?
owner String	Arbitrary descriptive label for the lock. Does not change the lock creator or permissions.
scope String
exclusive Bool	Is lock exclusive?
token String	Lock token. Use to release lock.
type String
allow_access_by_any_user Bool	Can lock be modified by users other than its creator?
user_id Int64	Lock creator user ID
username String	Lock creator username

Example Data Source

data "files_lock" "example_lock" {
  path  = "locked_file"
  token = "token"
}