Claim an environment share

• Latest Dynatrace
• Reference
• Published Oct 13, 2026

Claim an environment share in Dynatrace with the Document API, gaining the access rights defined by the share for another user’s document.

Overview

Claim this environment-share, therefore gaining access to the share's document. From thereafter, the document will be accessible to you with the specific permissions defined by the share. You can then access the document as usual, via the same endpoints which you would use to access your own documents.

Claiming your own shares isn't possible. You can only claim shares of documents belonging to other users of the same environment.

Once you have claimed access to a document, you can not revoke that access again.

The document's owner can revoke your access by deleting the share. This will effectively revoke the access you have been granted by claiming this share.

You can claim multiple shares of the same document, and each share will grant you different permissions.

Claiming the same share multiple times doesn't have any effect.

Authentication

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

Parameters

Response

{
  "documentId": "af21cc73-bb1c-45f1-ad1b-12e8f91b9fbc",
  "documentType": "dashboard",
  "access": [
    "read",
    "write"
  ]
}