Get a document

Latest Dynatrace
Reference
Published Oct 13, 2026

Retrieve a document in Dynatrace with the Document API, returning metadata and content together or a snapshot version when requested.


GET	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents/{id}`

Overview

You pass the document id path parameter and can optionally use filename, snapshot-version, admin-access, and add-fields. The response returns the document metadata and content in one multipart response, or the selected snapshot instead.

Authentication

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

Parameters

Parameter	Type	Description	In	Required
id	string	System-generated or user-given id of a document.	path	Required
filename	string	The optional `filename` query parameter can be passed to give the file that's being downloaded a user-provided name and file extension for downloading purposes. This name will be sent back to the client via the Content-Disposition HTTP header. The passed `filename` will be trimmed so that it doesn't contain any space characters around the name. When the `filename` isn't specified, then the name of the document is used as file name and no extension is added, since the service isn't aware of file extensions.	query	Optional
snapshot-version	integer	Snapshot version, to be used if you want to access a snapshot of the document.	query	Optional
admin-access	boolean	Indicates whether the operation should be performed with elevated permissions - additionally requires document:documents:admin. If provided, the user effectively operates as owner of all documents. This isn't supported for ready-made documents.	query	Optional
add-fields	string	Comma-separated list of field names that are added to the default set of fields. You can include the following additional fields: `userContext.lastAccessedTime` `userContext.isFavorite` `modificationInfo.lastModifyingAppId`	query	Optional

Response

Response codes

Code	Description
200	-
401	-
403	-
404	-
500	-
503	-
default	-

GET

SaaS

https://{your-environment-id}.apps.dynatrace.com/platform/document/v1/documents/{id}

Parameters

Parameter	Type	Description	In	Required
id	string	System-generated or user-given id of a document.	path	Required
filename	string	The optional `filename` query parameter can be passed to give the file that's being downloaded a user-provided name and file extension for downloading purposes. This name will be sent back to the client via the Content-Disposition HTTP header. The passed `filename` will be trimmed so that it doesn't contain any space characters around the name. When the `filename` isn't specified, then the name of the document is used as file name and no extension is added, since the service isn't aware of file extensions.	query	Optional
snapshot-version	integer	Snapshot version, to be used if you want to access a snapshot of the document.	query	Optional
admin-access	boolean	Indicates whether the operation should be performed with elevated permissions - additionally requires document:documents:admin. If provided, the user effectively operates as owner of all documents. This isn't supported for ready-made documents.	query	Optional
add-fields	string	Comma-separated list of field names that are added to the default set of fields. You can include the following additional fields: `userContext.lastAccessedTime` `userContext.isFavorite` `modificationInfo.lastModifyingAppId`	query	Optional

Code

Description

200

401

403

404

500

503

default