Start collecting a OneAgent support archive in Dynatrace with the Fleet Management API, with a description and the number of lookback days to include.
| POST | 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 and start collecting a support archive for it. The request body sets a description and lookbackDays, the number of past days the archive covers. A 202 response confirms that collection started; check its progress with the get operation and download the archive once it's finished.
To execute this request, you need a platform token or OAuth access token with fleet-management:oneagent.support-archives:write 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: ONEAGENT, PROCESS. | path | Required |
| body | Start | A description for the support archive. | body | Required |
StartSupportArchiveRequest objectRequest to start collecting a support archive.
| Element | Type | Description | Required |
|---|---|---|---|
| description | string | A description for the support archive. | Required |
| lookbackDays | integer | The number of days to look back for log data. | Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"description": "string","lookbackDays": 1}
| Code | Type | Description |
|---|---|---|
| 202 | Start | Accepted. Collection started. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
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 | - |
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}