Get one of your dashboard share configurations in Dynatrace by its share ID with the Public Access API to review its settings and access rules.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/shares/{shareId} |
You use the shareId path parameter, the UUID of a share configuration, to read one of your dashboard shares. A 200 response returns the configuration with its access rules, such as passcode protection, IP allowlist, expiry date, locale, timezone, and timeframe settings, so you can check how the public link behaves before you change it.
To execute this request, you need a platform token or OAuth access token with public-access:shares:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| shareId | string | The UUID of the share config | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Share | The share config |
| 404 | - | - |
| 4XX | - | - |
| 5XX | - | - |
ShareResponse object| Element | Type | Description |
|---|---|---|
| id | string | Share UUID |
| documentId | string | ID of the document being shared |
| name | string | Name of the share |
| expirationDate | string | Expiration date in ISO 8601 format |
| creationDate | string | Creation date of the share in ISO 8601 format |
| variables | object | Dashboard variables |
| timeframe | Timeframe | Timeframe override |
| filterSegments | Filter | Filter segments |
| locale | string | Locale (e.g. en-US) |
| timezone | string | Timezone (e.g. Europe/Vienna) |
| type | string | Share type The element can hold these values
|
| sessionTimeoutMinutes | integer | Session timeout in minutes; null when passcode is disabled |
| refreshIntervalMinutes | integer | Refresh interval in minutes |
| ipAllowList | object | - |
| passcode | Passcode | - |
| iframeEmbedding | Iframe | - |
| documentSnapshotDate | string | Date when the document snapshot was captured in ISO 8601 format |
| documentVersion | integer | Document version at the time the snapshot was captured |
Timeframe object| Element | Type | Description |
|---|---|---|
| from | string | Start of the timeframe as a relative or absolute expression parseable by the Dynatrace time parser (e.g. now()-2h, -1d@d, 2024-01-01T00:00:00Z). |
| to | string | End of the timeframe as a relative or absolute expression parseable by the Dynatrace time parser (e.g. now(), -1h@h, 2024-12-31T23:59:59Z). |
FilterSegment object| Element | Type | Description |
|---|---|---|
| id | string | Segment ID |
| variables | Filter | - |
FilterSegmentVariable object| Element | Type | Description |
|---|---|---|
| name | string | Variable name |
| values | string[] | Variable values |
PasscodeInfo object| Element | Type | Description |
|---|---|---|
| enabled | boolean | Whether passcode protection is enabled |
| value | string | The passcode value; null when passcode is disabled |
IframeEmbedding object| Element | Type | Description |
|---|---|---|
| enabled | boolean | Whether iframe embedding is enabled for this share |
{"id": "string","documentId": "string","name": "string","expirationDate": "string","creationDate": "string","variables": {},"timeframe": {"from": "now()-2h","to": "now()"},"filterSegments": [{"id": "string","variables": [{"name": "string","values": ["string"]}]}],"locale": "string","timezone": "string","type": "dashboard","sessionTimeoutMinutes": 1,"refreshIntervalMinutes": 1,"ipAllowList": {"enabled": true},"passcode": {"enabled": true,"value": "string"},"iframeEmbedding": {"enabled": true},"documentSnapshotDate": "string","documentVersion": 1}