Skip to content

Extend a lock

POST
/drives/{drive}/nodes/locks/{nodeLock}/refresh
curl --request POST \
--url https://work.optidata.cloud/api/drives/1/nodes/locks/4471/refresh \
--header 'Authorization: Bearer <token>'

Pushes the lock’s expiry forward. A client that keeps a file open must call this periodically, otherwise the lock lapses and another client may take it. Requires permission to update the lock.

drive
required
integer format: int64

Numeric id of the drive. Read it from GET /drives/config.json.

nodeLock
required
integer format: int64

Numeric id of the lock.

The refreshed lock.

Media typeapplication/json
object
key
additional properties
any
Examplegenerated
{}

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
"error": "JWT passport exception: Missing bearer token in request"
}

The caller lacks the permission level the operation requires.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
"message": "This action is unauthorized."
}

The resource does not exist, or does not belong to the given drive.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
"message": "No query results for model [App\\Models\\Node] 99999999"
}

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
"message": "Too Many Attempts."
}