Update any dashboard share in your Dynatrace environment as an admin with the Public Access API, such as its expiration date, passcode, or iframe embedding.
| PUT | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/admin/shares/{shareId} |
You use this admin operation with the shareId path parameter to change any dashboard share configuration in your environment, regardless of who created it. The request body can set expirationDate, passcode, and iframeEmbedding, for example to shorten a link's lifetime or require a passcode. A 200 response returns the updated configuration.
To execute this request, you need a platform token or OAuth access token with public-access:shares:admin 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 |
| body | Update | - | body | Required |
UpdateAdminShareRequest object| Element | Type | Description | Required |
|---|---|---|---|
| expirationDate | string | Expiration date in ISO 8601 format | Optional |
| passcode | Passcode | - | Required |
| iframeEmbedding | Iframe | - | Required |
PasscodeInput object| Element | Type | Description | Required |
|---|---|---|---|
| enabled | boolean | Whether passcode protection is enabled for the share config | Required |
IframeEmbedding object| Element | Type | Description | Required |
|---|---|---|---|
| enabled | boolean | Whether iframe embedding is enabled for this share | Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"expirationDate": "2030-01-01T00:00:00Z","passcode": {"enabled": true},"iframeEmbedding": {"enabled": true}}
| Code | Type | Description |
|---|---|---|
| 200 | Share | Updated shared 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}