Create an environment share

• Latest Dynatrace
• Reference
• Published Oct 13, 2026

Create an environment share in Dynatrace with the Document API, granting read or read-write access to a document for users who claim the share.

Overview

Create an environment-share, which can be used to give one or multiple other users access to this document. This is only possible for documents you own, as well as for reshareable documents owned by other users to which you have write access. A share can be created with either read or read-write access.

A document can have maximally one share per access type, therefore it's impossible to create multiple read-shares or multiple 'read-write'-shares for a single document.

This means, that you can create one read-share for a document, and this single read-share can be used to give read-access to an arbitrary number of users. The same applies to a 'read-write'-share.

Creating a share does not automatically allow users to access the document - only those users who explicitly claim the share gain access to the document.

Revoking access from users can be done by deleting the share.

Authentication

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

Parameters

{
  "documentId": "string",
  "access": "string"
}

Response

{
  "id": "af21cc73-bb1c-45f1-ad1b-12e8f91b9fbc",
  "documentId": "1d1cf013-fd4c-463e-a8ad-912485daf711",
  "access": [
    "read",
    "write"
  ],
  "claimCount": 0
}