{"_id":"@dynatrace-sdk/client-fleet-management","_rev":"2-4e8a8147a359b7a0a9654425ff31caef","name":"@dynatrace-sdk/client-fleet-management","dist-tags":{"latest":"1.1.2"},"versions":{"1.1.1":{"name":"@dynatrace-sdk/client-fleet-management","version":"1.1.1","license":"Apache-2.0","_id":"@dynatrace-sdk/client-fleet-management@1.1.1","maintainers":[{"name":"dynatrace-nodejs","email":"nodejs@dynatrace.com"},{"name":"stefan.wolfsteiner.dynatrace","email":"stefan.wolfsteiner@dynatrace.com"},{"name":"wasserb","email":"Stefan.wasserbauer@dynatrace.com"}],"dist":{"shasum":"56b835fcb2be85d381ec829711cca6edd09ab4ea","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-fleet-management/-/client-fleet-management-1.1.1.tgz","fileCount":8,"integrity":"sha512-dZRKIH4qsqvdR5MYQOEuDg3ChRKK8eyKbp3ahz0D+j7xAFb4c0ew8eyoiqtw9a4L44vv+uFoyHxfhZXLr4DjPg==","signatures":[{"sig":"MEQCICeysACZ/zSuh6O5K9VOLkfM/OjN8hdjtYjGv2UuLUjMAiBjRlA8BTDzJZ1XgBt395OwK4bl93z+nOFdzUvX1RWe/A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":348995},"main":"./cjs/index.js","_from":"file:dynatrace-sdk-client-fleet-management-1.1.1.tgz","types":"./types/index.d.ts","module":"./esm/index.js","_npmUser":{"name":"dynatrace-nodejs","email":"nodejs@dynatrace.com"},"_resolved":"/tmp/npm-publish-@dynatrace-sdk-client-fleet-management-1.1.1-G93KdJ/dynatrace-sdk-client-fleet-management-1.1.1.tgz","_integrity":"sha512-dZRKIH4qsqvdR5MYQOEuDg3ChRKK8eyKbp3ahz0D+j7xAFb4c0ew8eyoiqtw9a4L44vv+uFoyHxfhZXLr4DjPg==","_npmVersion":"11.6.2","description":"[![npm](https://img.shields.io/badge/npm-v1.1.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-fleet-management/v/1.1.1) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)","directories":{},"_nodeVersion":"24.13.0","dependencies":{"@dynatrace-sdk/http-client":"^1.5.1","@dynatrace-sdk/shared-errors":"^1.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/client-fleet-management_1.1.1_1784018547346_0.7168342135634909","host":"s3://npm-registry-packages-npm-production"}},"1.1.2":{"name":"@dynatrace-sdk/client-fleet-management","version":"1.1.2","dependencies":{"@dynatrace-sdk/http-client":"^1.5.1","@dynatrace-sdk/shared-errors":"^1.0.2"},"license":"Apache-2.0","main":"./cjs/index.js","module":"./esm/index.js","types":"./types/index.d.ts","_id":"@dynatrace-sdk/client-fleet-management@1.1.2","description":"[![npm](https://img.shields.io/badge/npm-v1.1.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-fleet-management/v/1.1.2) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)","_integrity":"sha512-cyjDQmnURBMpLQYUpKQJxiFYB5j6xQtpm/IE9d5An5P1zjhcC+UkJ/flvpULSqivOSPGgIvSUxxyBwMX22YrTQ==","_resolved":"/tmp/npm-publish-@dynatrace-sdk-client-fleet-management-1.1.2-odMDhr/dynatrace-sdk-client-fleet-management-1.1.2.tgz","_from":"file:dynatrace-sdk-client-fleet-management-1.1.2.tgz","_nodeVersion":"24.18.0","_npmVersion":"11.16.0","dist":{"integrity":"sha512-cyjDQmnURBMpLQYUpKQJxiFYB5j6xQtpm/IE9d5An5P1zjhcC+UkJ/flvpULSqivOSPGgIvSUxxyBwMX22YrTQ==","shasum":"1bc6602558549358ff38aab7c876642bd24c9bed","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-fleet-management/-/client-fleet-management-1.1.2.tgz","fileCount":8,"unpackedSize":349458,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIH2HgNJoYsJKktCwEMCLe3F1iJXWjbMvcytgzAzQqIZLAiASsQGPi5Vgm2NrJcIxQNREhlutSy9mnLrhLTwiSjnXag=="}]},"_npmUser":{"name":"dynatrace-nodejs","email":"nodejs@dynatrace.com"},"directories":{},"maintainers":[{"name":"dynatrace-nodejs","email":"nodejs@dynatrace.com"},{"name":"stefan.wolfsteiner.dynatrace","email":"stefan.wolfsteiner@dynatrace.com"},{"name":"wasserb","email":"Stefan.wasserbauer@dynatrace.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/client-fleet-management_1.1.2_1785504803099_0.3672984624899296"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-14T08:42:27.127Z","modified":"2026-07-31T13:33:23.512Z","1.1.1":"2026-07-14T08:42:27.491Z","1.1.2":"2026-07-31T13:33:23.260Z"},"license":"Apache-2.0","description":"[![npm](https://img.shields.io/badge/npm-v1.1.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-fleet-management/v/1.1.2) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)","maintainers":[{"name":"dynatrace-nodejs","email":"nodejs@dynatrace.com"},{"name":"stefan.wolfsteiner.dynatrace","email":"stefan.wolfsteiner@dynatrace.com"},{"name":"wasserb","email":"Stefan.wasserbauer@dynatrace.com"}],"readme":"# @dynatrace-sdk/client-fleet-management\n\n[![npm](https://img.shields.io/badge/npm-v1.1.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-fleet-management/v/1.1.2)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nThe Fleet Management API provides access to ActiveGate and OneAgent deployment data,\ninstaller downloads, ActiveGate tokens, container image URIs, Dynatrace network\naddresses, and support archive management.\n\n\n## Installation\n\n```bash\nnpm install @dynatrace-sdk/client-fleet-management\n```\n\n\n## Getting help\n\n- Visit [SDK for Typescript](https://developer.dynatrace.com/reference/sdks/) guide in the [Dynatrace Developer](https://developer.dynatrace.com/)\n- Ask a question in the [Dynatrace Community](https://community.dynatrace.com/)\n\n\n## License\n\nThis SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), see LICENSE for more information.\n\n\n# API reference\n\nFull API reference for the latest version of the SDK is also available at the [Dynatrace Developer](https://developer.dynatrace.com/reference/sdks/client-fleet-management/).\n\n## activeGateDeploymentClient\n\n```js\nimport { activeGateDeploymentClient } from '@dynatrace-sdk/client-fleet-management';\n```\n\n\n\n### downloadActiveGateInstallerByVersion\n\n
\nactiveGateDeploymentClient.downloadActiveGateInstallerByVersion(config): Promise<Binary>\n\n
\n\nDownloads specific ActiveGate installer version\n\n**Required scope:** fleet-management:activegates:download\n\nDownloads a specific version of ActiveGate installer for the specified OS type and architecture. The installer is provided in the raw installer format. For more information, see [ActiveGate raw installer](https://dt-url.net/uz038o9).\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.arch*required|\"all\" | \"amd64\" | \"arm64\" | \"s390\"|

The architecture of your OS:

|\n|config.ifNoneMatch|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ETag of the previous request. Don't download if it matches the ETag of the installer.|\n|config.osType*required|\"windows\" | \"unix\"|The operating system of the installer.|\n|config.version*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The requested version of the ActiveGate raw installer.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The payload contains the installer file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateDeploymentClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateDeploymentClient.downloadActiveGateInstallerByVersion(\n { osType: \"windows\", version: \"...\", arch: \"all\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### downloadLatestActiveGateInstaller\n\n
\nactiveGateDeploymentClient.downloadLatestActiveGateInstaller(config): Promise<Binary>\n\n
\n\nDownloads target version ActiveGate installer\n\n**Required scope:** fleet-management:activegates:download\n\nDownloads the ActiveGate installer for the specified OS type and architecture. The downloaded version is the configured ActiveGate target version. If no target version is configured, the latest available version is downloaded. The installer is provided in the raw installer format. For more information, see [ActiveGate raw installer](https://dt-url.net/uz038o9).\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.arch*required|\"all\" | \"amd64\" | \"arm64\" | \"s390\"|

The architecture of your OS:

|\n|config.ifNoneMatch|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ETag of the previous request. Don't download if it matches the ETag of the installer.|\n|config.osType*required|\"windows\" | \"unix\"|The operating system of the installer.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The payload contains the installer file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateDeploymentClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateDeploymentClient.downloadLatestActiveGateInstaller(\n { osType: \"windows\", arch: \"all\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### getActiveGateInstallerTargetVersion\n\n
\nactiveGateDeploymentClient.getActiveGateInstallerTargetVersion(config): Promise<ActiveGateInstallerVersion>\n\n
\n\nGets the target version of an ActiveGate installer\n\n**Required scope:** fleet-management:activegates:download\n\nReturns the configured ActiveGate target version for the tenant. If no target version is configured, the latest available version is returned.\n\n\n\n
\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateInstallerVersion](#activegateinstallerversion)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateDeploymentClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateDeploymentClient.getActiveGateInstallerTargetVersion();\n```\n\n
\n\n\n\n
\n\n\n\n### getActiveGateInstallerVersions\n\n
\nactiveGateDeploymentClient.getActiveGateInstallerVersions(config): Promise<ActiveGateInstallerVersions>\n\n
\n\nGets the list of available versions of an ActiveGate installer\n\n**Required scope:** fleet-management:activegates:download\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/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.

|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|

The amount of ActiveGate Installer versions in a single response payload.

The maximal allowed page size is 1000 and the minimum size is 10.

If not set, 10 is used.



Default: 10
Minimum: 10|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateInstallerVersions](#activegateinstallerversions)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateDeploymentClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateDeploymentClient.getActiveGateInstallerVersions();\n```\n\n
\n\n\n\n
\n\n\n\n### getConnectionInfo\n\n
\nactiveGateDeploymentClient.getConnectionInfo(config): Promise<ConnectionInfo>\n\n
\n\nProvides connection information for ActiveGate\n\n**Required scope:** fleet-management:activegate.connection-info:read\n\n\n\n
\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ConnectionInfo](#connectioninfo)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateDeploymentClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateDeploymentClient.getConnectionInfo();\n```\n\n
\n\n\n\n
\n\n## activeGateSupportArchivesClient\n\n```js\nimport { activeGateSupportArchivesClient } from '@dynatrace-sdk/client-fleet-management';\n```\n\n\n\n### cancelOrDeleteActiveGateSupportArchive\n\n
\nactiveGateSupportArchivesClient.cancelOrDeleteActiveGateSupportArchive(config): Promise<void>\n\n
\n\nCancels (if collecting) or deletes (if finished) ActiveGate support archive\n\n**Required scope:** fleet-management:activegate.support-archives:delete\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.|\n|config.supportArchiveId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the support archive.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|No content. Cancellation requested (if collecting) or deleted (if finished).|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateSupportArchivesClient.cancelOrDeleteActiveGateSupportArchive(\n { smartscapeNodeId: \"...\", supportArchiveId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### downloadActiveGateSupportArchiveZip\n\n
\nactiveGateSupportArchivesClient.downloadActiveGateSupportArchiveZip(config): Promise<void>\n\n
\n\nDownloads ActiveGate support archive ZIP\n\n**Required scope:** fleet-management:activegate.support-archives:download\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.|\n|config.supportArchiveId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the support archive.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Support archive ZIP.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateSupportArchivesClient.downloadActiveGateSupportArchiveZip(\n { smartscapeNodeId: \"...\", supportArchiveId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### getActiveGateSupportArchive\n\n
\nactiveGateSupportArchivesClient.getActiveGateSupportArchive(config): Promise<SupportArchive>\n\n
\n\nGets ActiveGate support archive by ID\n\n**Required scope:** fleet-management:activegate.support-archives:read\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.|\n|config.supportArchiveId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the support archive.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SupportArchive](#supportarchive)|200|Support archive details.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateSupportArchivesClient.getActiveGateSupportArchive(\n { smartscapeNodeId: \"...\", supportArchiveId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### listActiveGateSupportArchives\n\n
\nactiveGateSupportArchivesClient.listActiveGateSupportArchives(config): Promise<SupportArchiveListResponse>\n\n
\n\nLists ActiveGate support archives\n\n**Required scope:** fleet-management:activegate.support-archives:read\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/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.

|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|

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.



Default: 100
Minimum: 100|\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SupportArchiveListResponse](#supportarchivelistresponse)|200|List of support archives.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateSupportArchivesClient.listActiveGateSupportArchives(\n { smartscapeNodeId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### startActiveGateSupportArchiveCollection\n\n
\nactiveGateSupportArchivesClient.startActiveGateSupportArchiveCollection(config): Promise<StartSupportArchiveResponse>\n\n
\n\nStarts collecting ActiveGate support archive\n\n**Required scope:** fleet-management:activegate.support-archives:write\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body*required|StartSupportArchiveRequest||\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[StartSupportArchiveResponse](#startsupportarchiveresponse)|202|Accepted. Collection started.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await activeGateSupportArchivesClient.startActiveGateSupportArchiveCollection(\n {\n smartscapeNodeId: \"...\",\n body: { description: \"...\", lookbackDays: 10 },\n },\n );\n```\n\n
\n\n\n\n
\n\n## activeGateTokensClient\n\n```js\nimport { activeGateTokensClient } from '@dynatrace-sdk/client-fleet-management';\n```\n\n\n\n### createToken\n\n
\nactiveGateTokensClient.createToken(config): Promise<ActiveGateTokenCreated>\n\n
\n\nCreates a new ActiveGate token\n\n**One of the following scopes is required:**\n+ fleet-management:activegate.tokens:create\n+ fleet-management:activegate.tokens:write\n\n\n\nThe newly created token will be owned by the user authenticated for this request.\n\n**Make sure to copy the token secret** from the response---it won't be available again after creation.\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body*required|ActiveGateTokenCreate|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateTokenCreated](#activegatetokencreated)|201|Success. The token has been created. The response body contains the token secret.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateTokensClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data = await activeGateTokensClient.createToken({\n body: { name: \"myToken\" },\n});\n```\n\n
\n\n\n\n
\n\n\n\n### getToken\n\n
\nactiveGateTokensClient.getToken(config): Promise<ActiveGateToken>\n\n
\n\nGets the metadata of an ActiveGate token\n\n**Required scope:** fleet-management:activegate.tokens:read\n\nThe token secret **isn't** exposed.\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ActiveGate token identifier, consisting of the prefix and public parts of the token.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateToken](#activegatetoken)|200|Success. The response contains the metadata of the token.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateTokensClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data = await activeGateTokensClient.getToken({\n id: \"...\",\n});\n```\n\n
\n\n\n\n
\n\n\n\n### listTokens\n\n
\nactiveGateTokensClient.listTokens(config): Promise<ActiveGateTokenList>\n\n
\n\nLists all available ActiveGate tokens\n\n**Required scope:** fleet-management:activegate.tokens:read\n\nYou can limit the output by using pagination:\n1. Specify the number of results per page in the **page-size** query parameter.\n2. Use the cursor from the **nextPageKey** field of the previous response in the **page-key** query parameter to obtain subsequent pages.\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/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.

|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|

The amount of ActiveGate tokens in a single response payload.

The maximal allowed page size is 3000 and the minimum size is 100.

If not set, 100 is used.



Default: 100
Minimum: 100|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateTokenList](#activegatetokenlist)|200|Success. The response contains the list of ActiveGate tokens.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateTokensClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data = await activeGateTokensClient.listTokens();\n```\n\n
\n\n\n\n
\n\n\n\n### revokeToken\n\n
\nactiveGateTokensClient.revokeToken(config): Promise<void>\n\n
\n\nDeletes an ActiveGate token\n\n**Required scope:** fleet-management:activegate.tokens:write\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of the ActiveGate token to be deleted, consisting of the prefix and public parts of the token.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Response doesn't have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { activeGateTokensClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data = await activeGateTokensClient.revokeToken({\n id: \"...\",\n});\n```\n\n
\n\n\n\n
\n\n## containerImagesClient\n\n```js\nimport { containerImagesClient } from '@dynatrace-sdk/client-fleet-management';\n```\n\n\n\n### getContainerImages\n\n
\ncontainerImagesClient.getContainerImages(config): Promise<ContainerImageData>\n\n
\n\nReturns container images data\n\n**Required scope:** fleet-management:container-images:read\n\nReturns container image references for Dynatrace components from the specified registry. Returned image versions are resolved based on the configured target versions: dynatrace-activegate, dynatrace-eec, dynatrace-sql-extension-executor, and dynatrace-database-datasource-executor image versions are resolved from the ActiveGate target version; dynatrace-oneagent, dynatrace-codemodules, and dynatrace-logmodule image versions are resolved from the OneAgent target version. If no target version is configured for a component, the latest available image is returned.\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.registry|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Registry name containing the container images. For a list of registries, see Dynatrace Documentation|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ContainerImageData](#containerimagedata)|200|Container images data returned|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { containerImagesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await containerImagesClient.getContainerImages();\n```\n\n
\n\n\n\n
\n\n## dynatraceNetworkAddressesClient\n\n```js\nimport { dynatraceNetworkAddressesClient } from '@dynatrace-sdk/client-fleet-management';\n```\n\n\n\n### getDynatraceNetworkAddresses\n\n
\ndynatraceNetworkAddressesClient.getDynatraceNetworkAddresses(config): Promise<NetworkAddresses>\n\n
\n\nProvides the Dynatrace addresses\n\n**Required scope:** fleet-management:public-addresses:read\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/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.

|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|

The amount of Dynatrace addresses in a single response payload.

The maximal allowed page size is 1000 and the minimum size is 10.

If not set, 10 is used.



Default: 10
Minimum: 10|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[NetworkAddresses](#networkaddresses)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { dynatraceNetworkAddressesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await dynatraceNetworkAddressesClient.getDynatraceNetworkAddresses();\n```\n\n
\n\n\n\n
\n\n## oneAgentSupportArchivesClient\n\n```js\nimport { oneAgentSupportArchivesClient } from '@dynatrace-sdk/client-fleet-management';\n```\n\n\n\n### cancelOrDeleteOneAgentSupportArchive\n\n
\noneAgentSupportArchivesClient.cancelOrDeleteOneAgentSupportArchive(config): Promise<void>\n\n
\n\nCancels (if collecting) or deletes (if finished) OneAgent support archive\n\n**Required scope:** fleet-management:oneagent.support-archives:delete\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.|\n|config.supportArchiveId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the support archive.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|No content. Cancellation requested (if collecting) or deleted (if finished).|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { oneAgentSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await oneAgentSupportArchivesClient.cancelOrDeleteOneAgentSupportArchive(\n { smartscapeNodeId: \"...\", supportArchiveId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### downloadOneAgentSupportArchiveZip\n\n
\noneAgentSupportArchivesClient.downloadOneAgentSupportArchiveZip(config): Promise<void>\n\n
\n\nDownloads OneAgent support archive ZIP\n\n**Required scope:** fleet-management:oneagent.support-archives:download\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.|\n|config.supportArchiveId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the support archive.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Support archive ZIP.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { oneAgentSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await oneAgentSupportArchivesClient.downloadOneAgentSupportArchiveZip(\n { smartscapeNodeId: \"...\", supportArchiveId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### getOneAgentSupportArchive\n\n
\noneAgentSupportArchivesClient.getOneAgentSupportArchive(config): Promise<SupportArchive>\n\n
\n\nGets OneAgent support archive by ID\n\n**Required scope:** fleet-management:oneagent.support-archives:read\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.|\n|config.supportArchiveId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the support archive.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SupportArchive](#supportarchive)|200|Support archive details.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { oneAgentSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await oneAgentSupportArchivesClient.getOneAgentSupportArchive(\n { smartscapeNodeId: \"...\", supportArchiveId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### listOneAgentSupportArchives\n\n
\noneAgentSupportArchivesClient.listOneAgentSupportArchives(config): Promise<SupportArchiveListResponse>\n\n
\n\nLists OneAgent support archives\n\n**Required scope:** fleet-management:oneagent.support-archives:read\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/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.

|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|

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.



Default: 100
Minimum: 100|\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SupportArchiveListResponse](#supportarchivelistresponse)|200|List of support archives.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { oneAgentSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await oneAgentSupportArchivesClient.listOneAgentSupportArchives(\n { smartscapeNodeId: \"...\" },\n );\n```\n\n
\n\n\n\n
\n\n\n\n### startOneAgentSupportArchiveCollection\n\n
\noneAgentSupportArchivesClient.startOneAgentSupportArchiveCollection(config): Promise<StartSupportArchiveResponse>\n\n
\n\nStarts collecting OneAgent support archive\n\n**Required scope:** fleet-management:oneagent.support-archives:write\n\n\n\n
\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body*required|StartSupportArchiveRequest||\n|config.smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[StartSupportArchiveResponse](#startsupportarchiveresponse)|202|Accepted. Collection started.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client side error. | Server side error.|\n\n\n
\n\nCode example\n\n\n```ts\nimport { oneAgentSupportArchivesClient } from \"@dynatrace-sdk/client-fleet-management\";\n\nconst data =\n await oneAgentSupportArchivesClient.startOneAgentSupportArchiveCollection(\n {\n smartscapeNodeId: \"...\",\n body: { description: \"...\", lookbackDays: 10 },\n },\n );\n```\n\n
\n\n\n\n
\n\n## Types\n\n### ActiveGateInstallerVersion\n\nActiveGate Installer version\n\n| Name | Type | Description |\n| --- | --- | --- |\n|version*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ActiveGate installer version.|\n\n### ActiveGateInstallerVersions\n\nList of available ActiveGate Installer versions\n\n| Name | Type | Description |\n| --- | --- | --- |\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|

The cursor for the next page of results. Has the value of null on the last page.

Use it in the page-key query parameter to obtain subsequent pages of the result.



Example: AQAAABQBAAAABQ==|\n|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.

Example: 100|\n|totalCount*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The total number of entries in the result.

Example: 1000|\n|versions*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|ActiveGate installer versions.|\n\n### ActiveGateToken\n\nMetadata of an ActiveGate token.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|creationDate*required|Date|The token creation date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

Example: 2020-11-22T08:15:30.144Z|\n|expirationDate|Date|

The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

If not set, the token never expires.



Example: 2020-11-24T08:15:30.144Z|\n|id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ActiveGate token identifier, consisting of the prefix and public parts of the token.

Example: dt0g02.4KWZO5EF|\n|lastUsedDate|Date|The token last used date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

Example: 2020-11-23T08:15:30.144Z|\n|name*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token.

Example: myToken|\n|owner*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The owner of the token.

Example: john.smith|\n|seedToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is a seed token (true) or an individual token (false).

Default: false
Example: false|\n\n### ActiveGateTokenCreate\n\nParameters of a new ActiveGate token.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|expirationDate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|

The expiration date of the token.

You can use one of the following formats:

If not set, the token never expires.

Ensure that it's not set in the past and doesn't exceed 2 years from the moment of creation.



Example: now+6M|\n|name*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the token.

Example: myToken|\n|seedToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|

The token is a seed token (true) or an individual token (false).

We recommend the individual token option (false).



Default: false
Example: false|\n\n### ActiveGateTokenCreated\n\nThe newly created ActiveGate token.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|expirationDate|Date|The token expiration date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

Example: 2020-11-24T08:15:30.144Z|\n|id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ActiveGate token identifier, consisting of the prefix and public parts of the token.

Example: dt0g02.4KWZO5EF|\n|seedToken|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The token is a seed token (true) or an individual token (false).

Example: false|\n|token*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The secret of the token. Make sure to copy it-—-you won't be able to retrieve it again.

Example: dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E|\n\n### ActiveGateTokenList\n\nA list of ActiveGate tokens.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|activeGateTokens*required|Array<ActiveGateToken>|A list of ActiveGate tokens.|\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|

The cursor for the next page of results. Has the value of null on the last page.

Use it in the page-key query parameter to obtain subsequent pages of the result.



Example: AQAAABQBAAAABQ==|\n|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.

Example: 100|\n|totalCount*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The total number of entries in the result.

Example: 1000|\n\n### ConnectionInfo\n\nConnection info with tenant data and initial tenant endpoint\n\n| Name | Type | Description |\n| --- | --- | --- |\n|initialEndpoint|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Initial tenant endpoint.|\n|tenantToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Tenant token.|\n|tenantUUID|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Tenant UUID.|\n\n### ConstraintViolation\n\nA list of constraint violations\n\n| Name | Type |\n| --- | --- |\n|location|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n|parameterLocation|\"HEADER\" | \"PATH\" | \"PAYLOAD_BODY\" | \"QUERY\"|\n|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### ContainerImageComponent\n\nInformation about component type and images registry URI.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|imageUri|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Registry URI of the container image component.|\n|type|\"activegate\" | \"codemodules\" | \"database-datasource-executor\" | \"sql-extension-executor\" | \"dynatrace-sql-extension-executor\" | \"eec\" | \"logmodule\" | \"oneagent\"|Container image component type.|\n\n### ContainerImageData\n\nInformation about images registry and components with URI.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|components*required|Array<ContainerImageComponent>|List of container image components.|\n|registry|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Registry name containing container images.|\n\n### Error\n\n| Name | Type | Description |\n| --- | --- | --- |\n|code|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code|\n|constraintViolations|Array<ConstraintViolation>|A list of constraint violations|\n|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message|\n\n### ErrorEnvelope\n\n| Name | Type |\n| --- | --- |\n|error|Error|\n\n### NetworkAddresses\n\nList of Dynatrace addresses\n\n| Name | Type | Description |\n| --- | --- | --- |\n|addresses*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|List of Dynatrace addresses.|\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|

The cursor for the next page of results. Has the value of null on the last page.

Use it in the page-key query parameter to obtain subsequent pages of the result.



Example: AQAAABQBAAAABQ==|\n|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.

Example: 100|\n|totalCount*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The total number of entries in the result.

Example: 1000|\n\n### ResourceStatus\n\nLifecycle status of a long-running operation resource.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|status*required|\"ANALYZING_ARCHIVE\" | \"ANALYZING_DONE\" | \"ANALYZING_FAILED\" | \"CANCELED\" | \"COLLECTED\" | \"COLLECT_ERROR\" | \"COLLECT_IN_PROGRESS\" | \"DELETED\" | \"DELETE_ERROR\" | \"DELETE_IN_PROGRESS\" | \"MANUAL_CLEANUP\" | \"REANALYZING_NEEDED\" | \"SENDING_FAILED\" | \"SENDING_IN_PROGRESS\" | \"SENT_TO_DYNATRACE_CLOUD\"|The current lifecycle status of the resource.|\n\n### StartSupportArchiveRequest\n\nRequest to start collecting a support archive.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|description*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A description for the support archive.|\n|lookbackDays*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of days to look back for log data.

Minimum: 1|\n\n### StartSupportArchiveResponse\n\nResponse after starting a support archive collection.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the newly created support archive.|\n\n### SupportArchive\n\nRepresents a support archive.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|collectedBy*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The user who triggered the collection.|\n|collectionTimestamp|Date|The ISO 8601 UTC timestamp when the archive was collected. Null while the archive is still being collected.|\n|description*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User-provided description.|\n|id*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The support archive ID.|\n|lookbackDays*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The lookback duration in days.|\n|resourceStatus*required|ResourceStatus|Lifecycle status of a long-running operation resource.|\n|sizeKb|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The size of the support archive in KB. Null while the archive is still being collected.|\n|smartscapeNodeId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Smartscape node ID of the entity.|\n\n### SupportArchiveListResponse\n\nA list of support archives.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|items*required|Array<SupportArchive>|The list of support archives.|\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|

The cursor for the next page of results. Has the value of null on the last page.

Use it in the page-key query parameter to obtain subsequent pages of the result.



Example: AQAAABQBAAAABQ==|\n|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page.

Example: 100|\n|totalCount*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The total number of entries in the result.

Example: 1000|\n\n## Enums\n\n\n### ~~ConstraintViolationParameterLocation~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n
\n\n\n\n#### Enum keys\n\n
\n\n`Header` | `Path` | `PayloadBody` | `Query`\n\n
\n\n\n
\n\n\n### ~~ContainerImageComponentType~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n
\n\nContainer image component type.\n\n#### Enum keys\n\n
\n\n`Activegate` | `Codemodules` | `DatabaseDatasourceExecutor` | `DynatraceSqlExtensionExecutor` | `Eec` | `Logmodule` | `Oneagent` | `SqlExtensionExecutor`\n\n
\n\n\n
\n\n\n### ~~DownloadActiveGateInstallerByVersionPathArch~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n
\n\n\n\n#### Enum keys\n\n
\n\n`All` | `Amd64` | `Arm64` | `S390`\n\n
\n\n\n
\n\n\n### ~~DownloadActiveGateInstallerByVersionPathOsType~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n
\n\n\n\n#### Enum keys\n\n
\n\n`Unix` | `Windows`\n\n
\n\n\n
\n\n\n### ~~DownloadLatestActiveGateInstallerPathArch~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n
\n\n\n\n#### Enum keys\n\n
\n\n`All` | `Amd64` | `Arm64` | `S390`\n\n
\n\n\n
\n\n\n### ~~DownloadLatestActiveGateInstallerPathOsType~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n
\n\n\n\n#### Enum keys\n\n
\n\n`Unix` | `Windows`\n\n
\n\n\n
\n\n\n### ~~ResourceStatusStatus~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n
\n\nThe current lifecycle status of the resource.\n\n#### Enum keys\n\n
\n\n`AnalyzingArchive` | `AnalyzingDone` | `AnalyzingFailed` | `Canceled` | `CollectError` | `CollectInProgress` | `Collected` | `DeleteError` | `DeleteInProgress` | `Deleted` | `ManualCleanup` | `ReanalyzingNeeded` | `SendingFailed` | `SendingInProgress` | `SentToDynatraceCloud`\n\n
\n\n\n
\n","readmeFilename":"README.md"}