List the support archives collected for a OneAgent in Dynatrace with the Fleet Management API, page by page, to find diagnostics for a support case.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/oneagent/support-archives/{smartscape-node-id} |
You use the smartscape-node-id path parameter to choose the OneAgent, whose valid node types include ONEAGENT and PROCESS, and list the support archives collected for it. The response is paginated: set page-size for the number of archives per page and pass the nextPageKey from a previous response as page-key to get the next page.
To execute this request, you need a platform token or OAuth access token with fleet-management:oneagent.support-archives:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| page-key | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the page-key query parameter. When the page-key is set to obtain subsequent pages, you must omit all other query parameters. | query | Optional |
| page-size | integer | The amount of Support archives in a single response payload. The maximal allowed page size is 500 and the minimum size is 100. If not set, 100 is used. | query | Optional |
| smartscape-node-id | string | The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS. | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Support | List of support archives. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SupportArchiveListResponse objectA list of support archives.
| Element | Type | Description |
|---|---|---|
| items | Support | The list of support archives. |
| nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the page-key query parameter to obtain subsequent pages of the result. |
| pageSize | integer | The number of entries per page. |
| totalCount | string | The total number of entries in the result. |
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 | - |
{"items": [{"collectedBy": "string","collectionTimestamp": "string","description": "string","id": "string","lookbackDays": 1,"resourceStatus": {"status": "ANALYZING_ARCHIVE"},"sizeKb": "string","smartscapeNodeId": "string"}],"nextPageKey": "AQAAABQBAAAABQ==","pageSize": 100,"totalCount": "1000"}
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}