Acquire a document lock

• Latest Dynatrace
• Reference
• Published Oct 13, 2026

Acquire a document lock in Dynatrace with the Document API, preventing other users from updating the document while the lock is held.

Overview

Acquire the lock on the document. A user can lock a maximum of five documents at any given time. Once the lock is acquired by the user, other users cannot make any updates to the document.

The user acquiring the lock can optionally specify the duration for which the lock can be attained. However, the specified duration must not exceed the maximum allowed duration of 15 minutes. If not specified, the lock is acquired for 10 minutes.

If the user who has currently locked the document attempts to acquire the lock for the same document again, the duration of the lock gets extended by the specified duration or by a default duration of 10 minutes, if not specified.

The other users would not be allowed to acquire the lock on an already locked document.

Authentication

To execute this request, you need a platform token or OAuth access token with document:documents:write scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

{
  "documentVersion": 3,
  "lockDurationInSeconds": 20
}

Response

{
  "documentVersion": 3,
  "lockedUntil": "2023-08-10T05:11:11Z"
}