Get the details of a ActiveGate support archive in Dynatrace with the Fleet Management API by its ID, for example to check whether collection has finished.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/activegate/support-archives/{smartscape-node-id}/{support-archive-id} |
You use the smartscape-node-id and support-archive-id path parameters to read the details of one support archive for a ActiveGate. A 200 response returns the archive details. Typical usage is checking whether a collection you started has finished before you download the archive.
To execute this request, you need a platform token or OAuth access token with fleet-management:activegate.support-archives:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| smartscape-node-id | string | The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE. | path | Required |
| support-archive-id | string | The ID of the support archive. | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Support | Support archive details. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SupportArchive objectRepresents a support archive.
| Element | Type | Description |
|---|---|---|
| collectedBy | string | The user who triggered the collection. |
| collectionTimestamp | string | The ISO 8601 UTC timestamp when the archive was collected. Null while the archive is still being collected. |
| description | string | User-provided description. |
| id | string | The support archive ID. |
| lookbackDays | integer | The lookback duration in days. |
| resourceStatus | Resource | Lifecycle status of a long-running operation resource. |
| sizeKb | string | The size of the support archive in KB. Null while the archive is still being collected. |
| smartscapeNodeId | string | The Smartscape node ID of the entity. |
ResourceStatus objectLifecycle status of a long-running operation resource.
| Element | Type | Description |
|---|---|---|
| status | string | The current lifecycle status of the resource. The element can hold these values
|
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"collectedBy": "string","collectionTimestamp": "string","description": "string","id": "string","lookbackDays": 1,"resourceStatus": {"status": "ANALYZING_ARCHIVE"},"sizeKb": "string","smartscapeNodeId": "string"}
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}