@dynatrace-sdk/client-fleet-management

The Fleet Management API provides access to ActiveGate and OneAgent deployment data, installer downloads, ActiveGate tokens, container image URIs, Dynatrace network addresses, and support archive management.

Installation

npm install @dynatrace-sdk/client-fleet-management

Getting help

• Visit SDK for Typescript guide in the Dynatrace Developer
• Ask a question in the Dynatrace Community

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

API reference

Full API reference for the latest version of the SDK is also available at the Dynatrace Developer.

activeGateDeploymentClient

import { activeGateDeploymentClient } from '@dynatrace-sdk/client-fleet-management';

downloadActiveGateInstallerByVersion

Downloads specific ActiveGate installer version

Required scope: fleet-management:activegates:download

Downloads 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.

Parameters

| Name | Type | Description | | --- | --- | --- | |config.arch*required|"all" | "amd64" | "arm64" | "s390"|The architecture of your OS: all: Defaults to amd64. amd64: amd64 architecture. s390: S/390 architecture, only supported for Linux. arm64: arm64 architecture, only supported for Linux. | |config.ifNoneMatch|string|The ETag of the previous request. Don't download if it matches the ETag of the installer.| |config.osType*required|"windows" | "unix"|The operating system of the installer.| |config.version*required|string|The requested version of the ActiveGate raw installer.|

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Success. The payload contains the installer file.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateDeploymentClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateDeploymentClient.downloadActiveGateInstallerByVersion(
    { osType: "windows", version: "...", arch: "all" },
  );

downloadLatestActiveGateInstaller

Downloads target version ActiveGate installer

Required scope: fleet-management:activegates:download

Downloads 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.

Parameters

| Name | Type | Description | | --- | --- | --- | |config.arch*required|"all" | "amd64" | "arm64" | "s390"|The architecture of your OS: all: Defaults to amd64. amd64: amd64 architecture. s390: S/390 architecture, only supported for Linux. arm64: arm64 architecture, only supported for Linux. | |config.ifNoneMatch|string|The ETag of the previous request. Don't download if it matches the ETag of the installer.| |config.osType*required|"windows" | "unix"|The operating system of the installer.|

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Success. The payload contains the installer file.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateDeploymentClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateDeploymentClient.downloadLatestActiveGateInstaller(
    { osType: "windows", arch: "all" },
  );

getActiveGateInstallerTargetVersion

Gets the target version of an ActiveGate installer

Required scope: fleet-management:activegates:download

Returns the configured ActiveGate target version for the tenant. If no target version is configured, the latest available version is returned.

Returns

| Return type | Status code | Description | |---|---|---| |ActiveGateInstallerVersion|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateDeploymentClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateDeploymentClient.getActiveGateInstallerTargetVersion();

getActiveGateInstallerVersions

Gets the list of available versions of an ActiveGate installer

Required scope: fleet-management:activegates:download

Parameters

| Name | Type | Description | | --- | --- | --- | |config.pageKey|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. | |config.pageSize|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: 10Minimum: 10|

Returns

| Return type | Status code | Description | |---|---|---| |ActiveGateInstallerVersions|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateDeploymentClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateDeploymentClient.getActiveGateInstallerVersions();

getConnectionInfo

Provides connection information for ActiveGate

Required scope: fleet-management:activegate.connection-info:read

Returns

| Return type | Status code | Description | |---|---|---| |ConnectionInfo|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateDeploymentClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateDeploymentClient.getConnectionInfo();

activeGateSupportArchivesClient

import { activeGateSupportArchivesClient } from '@dynatrace-sdk/client-fleet-management';

cancelOrDeleteActiveGateSupportArchive

Cancels (if collecting) or deletes (if finished) ActiveGate support archive

Required scope: fleet-management:activegate.support-archives:delete

Parameters

| Name | Type | Description | | --- | --- | --- | |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.| |config.supportArchiveId*required|string|The ID of the support archive.|

Returns

| Return type | Status code | Description | |---|---|---| |void|204|No content. Cancellation requested (if collecting) or deleted (if finished).|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateSupportArchivesClient.cancelOrDeleteActiveGateSupportArchive(
    { smartscapeNodeId: "...", supportArchiveId: "..." },
  );

downloadActiveGateSupportArchiveZip

Downloads ActiveGate support archive ZIP

Required scope: fleet-management:activegate.support-archives:download

Parameters

| Name | Type | Description | | --- | --- | --- | |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.| |config.supportArchiveId*required|string|The ID of the support archive.|

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Support archive ZIP.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateSupportArchivesClient.downloadActiveGateSupportArchiveZip(
    { smartscapeNodeId: "...", supportArchiveId: "..." },
  );

getActiveGateSupportArchive

Gets ActiveGate support archive by ID

Required scope: fleet-management:activegate.support-archives:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.| |config.supportArchiveId*required|string|The ID of the support archive.|

Returns

| Return type | Status code | Description | |---|---|---| |SupportArchive|200|Support archive details.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateSupportArchivesClient.getActiveGateSupportArchive(
    { smartscapeNodeId: "...", supportArchiveId: "..." },
  );

listActiveGateSupportArchives

Lists ActiveGate support archives

Required scope: fleet-management:activegate.support-archives:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.pageKey|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. | |config.pageSize|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: 100Minimum: 100| |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.|

Returns

| Return type | Status code | Description | |---|---|---| |SupportArchiveListResponse|200|List of support archives.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateSupportArchivesClient.listActiveGateSupportArchives(
    { smartscapeNodeId: "..." },
  );

startActiveGateSupportArchiveCollection

Starts collecting ActiveGate support archive

Required scope: fleet-management:activegate.support-archives:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|StartSupportArchiveRequest|| |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ACTIVEGATE, SYNTHETIC_ENGINE, ZREMOTE.|

Returns

| Return type | Status code | Description | |---|---|---| |StartSupportArchiveResponse|202|Accepted. Collection started.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await activeGateSupportArchivesClient.startActiveGateSupportArchiveCollection(
    {
      smartscapeNodeId: "...",
      body: { description: "...", lookbackDays: 10 },
    },
  );

activeGateTokensClient

import { activeGateTokensClient } from '@dynatrace-sdk/client-fleet-management';

createToken

Creates a new ActiveGate token

One of the following scopes is required:

• fleet-management:activegate.tokens:create
• fleet-management:activegate.tokens:write

The newly created token will be owned by the user authenticated for this request.

Make sure to copy the token secret from the response---it won't be available again after creation.

Parameters

| Name | Type | | --- | --- | |config.body*required|ActiveGateTokenCreate|

Returns

| Return type | Status code | Description | |---|---|---| |ActiveGateTokenCreated|201|Success. The token has been created. The response body contains the token secret.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateTokensClient } from "@dynatrace-sdk/client-fleet-management";

const data = await activeGateTokensClient.createToken({
  body: { name: "myToken" },
});

getToken

Gets the metadata of an ActiveGate token

Required scope: fleet-management:activegate.tokens:read

The token secret isn't exposed.

Parameters

| Name | Type | Description | | --- | --- | --- | |config.id*required|string|The ActiveGate token identifier, consisting of the prefix and public parts of the token.|

Returns

| Return type | Status code | Description | |---|---|---| |ActiveGateToken|200|Success. The response contains the metadata of the token.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateTokensClient } from "@dynatrace-sdk/client-fleet-management";

const data = await activeGateTokensClient.getToken({
  id: "...",
});

listTokens

Lists all available ActiveGate tokens

Required scope: fleet-management:activegate.tokens:read

You can limit the output by using pagination:

1. Specify the number of results per page in the page-size query parameter.
2. Use the cursor from the nextPageKey field of the previous response in the page-key query parameter to obtain subsequent pages.

Parameters

| Name | Type | Description | | --- | --- | --- | |config.pageKey|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. | |config.pageSize|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: 100Minimum: 100|

Returns

| Return type | Status code | Description | |---|---|---| |ActiveGateTokenList|200|Success. The response contains the list of ActiveGate tokens.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateTokensClient } from "@dynatrace-sdk/client-fleet-management";

const data = await activeGateTokensClient.listTokens();

revokeToken

Deletes an ActiveGate token

Required scope: fleet-management:activegate.tokens:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.id*required|string|The identifier of the ActiveGate token to be deleted, consisting of the prefix and public parts of the token.|

Returns

| Return type | Status code | Description | |---|---|---| |void|204|Success. Response doesn't have a body.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { activeGateTokensClient } from "@dynatrace-sdk/client-fleet-management";

const data = await activeGateTokensClient.revokeToken({
  id: "...",
});

containerImagesClient

import { containerImagesClient } from '@dynatrace-sdk/client-fleet-management';

getContainerImages

Returns container images data

Required scope: fleet-management:container-images:read

Returns 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.

Parameters

| Name | Type | Description | | --- | --- | --- | |config.registry|string|Registry name containing the container images. For a list of registries, see Dynatrace Documentation|

Returns

| Return type | Status code | Description | |---|---|---| |ContainerImageData|200|Container images data returned|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { containerImagesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await containerImagesClient.getContainerImages();

dynatraceNetworkAddressesClient

import { dynatraceNetworkAddressesClient } from '@dynatrace-sdk/client-fleet-management';

getDynatraceNetworkAddresses

Provides the Dynatrace addresses

Required scope: fleet-management:public-addresses:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.pageKey|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. | |config.pageSize|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: 10Minimum: 10|

Returns

| Return type | Status code | Description | |---|---|---| |NetworkAddresses|200|Success|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { dynatraceNetworkAddressesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await dynatraceNetworkAddressesClient.getDynatraceNetworkAddresses();

oneAgentSupportArchivesClient

import { oneAgentSupportArchivesClient } from '@dynatrace-sdk/client-fleet-management';

cancelOrDeleteOneAgentSupportArchive

Cancels (if collecting) or deletes (if finished) OneAgent support archive

Required scope: fleet-management:oneagent.support-archives:delete

Parameters

| Name | Type | Description | | --- | --- | --- | |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.| |config.supportArchiveId*required|string|The ID of the support archive.|

Returns

| Return type | Status code | Description | |---|---|---| |void|204|No content. Cancellation requested (if collecting) or deleted (if finished).|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { oneAgentSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await oneAgentSupportArchivesClient.cancelOrDeleteOneAgentSupportArchive(
    { smartscapeNodeId: "...", supportArchiveId: "..." },
  );

downloadOneAgentSupportArchiveZip

Downloads OneAgent support archive ZIP

Required scope: fleet-management:oneagent.support-archives:download

Parameters

| Name | Type | Description | | --- | --- | --- | |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.| |config.supportArchiveId*required|string|The ID of the support archive.|

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Support archive ZIP.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { oneAgentSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await oneAgentSupportArchivesClient.downloadOneAgentSupportArchiveZip(
    { smartscapeNodeId: "...", supportArchiveId: "..." },
  );

getOneAgentSupportArchive

Gets OneAgent support archive by ID

Required scope: fleet-management:oneagent.support-archives:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.| |config.supportArchiveId*required|string|The ID of the support archive.|

Returns

| Return type | Status code | Description | |---|---|---| |SupportArchive|200|Support archive details.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { oneAgentSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await oneAgentSupportArchivesClient.getOneAgentSupportArchive(
    { smartscapeNodeId: "...", supportArchiveId: "..." },
  );

listOneAgentSupportArchives

Lists OneAgent support archives

Required scope: fleet-management:oneagent.support-archives:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.pageKey|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. | |config.pageSize|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: 100Minimum: 100| |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.|

Returns

| Return type | Status code | Description | |---|---|---| |SupportArchiveListResponse|200|List of support archives.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { oneAgentSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await oneAgentSupportArchivesClient.listOneAgentSupportArchives(
    { smartscapeNodeId: "..." },
  );

startOneAgentSupportArchiveCollection

Starts collecting OneAgent support archive

Required scope: fleet-management:oneagent.support-archives:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|StartSupportArchiveRequest|| |config.smartscapeNodeId*required|string|The Smartscape node ID of the entity. Valid node types: ONEAGENT, PROCESS.|

Returns

| Return type | Status code | Description | |---|---|---| |StartSupportArchiveResponse|202|Accepted. Collection started.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Client side error. | Server side error.|

import { oneAgentSupportArchivesClient } from "@dynatrace-sdk/client-fleet-management";

const data =
  await oneAgentSupportArchivesClient.startOneAgentSupportArchiveCollection(
    {
      smartscapeNodeId: "...",
      body: { description: "...", lookbackDays: 10 },
    },
  );

Types

ActiveGateInstallerVersion

ActiveGate Installer version

| Name | Type | Description | | --- | --- | --- | |version*required|string|ActiveGate installer version.|

ActiveGateInstallerVersions

List of available ActiveGate Installer versions

| Name | Type | Description | | --- | --- | --- | |nextPageKey|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==| |pageSize|number|The number of entries per page.Example: 100| |totalCount*required|string|The total number of entries in the result.Example: 1000| |versions*required|Array<string>|ActiveGate installer versions.|

ActiveGateToken

Metadata of an ActiveGate token.

| Name | Type | Description | | --- | --- | --- | |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| |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| |id*required|string|The ActiveGate token identifier, consisting of the prefix and public parts of the token.Example: dt0g02.4KWZO5EF| |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| |name*required|string|The name of the token.Example: myToken| |owner*required|string|The owner of the token.Example: john.smith| |seedToken|boolean|The token is a seed token (true) or an individual token (false).Default: falseExample: false|

ActiveGateTokenCreate

Parameters of a new ActiveGate token.

| Name | Type | Description | | --- | --- | --- | |expirationDate|string|The expiration date of the token. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of 2021-01-25T05:57:01.123+01:00. If no time zone is specified, UTC is used. You can use a space character instead of the T. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is now-NU/A, where N is the amount of time, U is the unit of time, and A is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, now-1y/w is one year back, aligned by a week. You can also specify relative timeframe without an alignment: now-NU. Supported time units for the relative timeframe are: m: minutes h: hours d: days w: weeks M: months y: years 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| |name*required|string|The name of the token.Example: myToken| |seedToken|boolean|The token is a seed token (true) or an individual token (false). We recommend the individual token option (false). Default: falseExample: false|

ActiveGateTokenCreated

The newly created ActiveGate token.

| Name | Type | Description | | --- | --- | --- | |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| |id*required|string|The ActiveGate token identifier, consisting of the prefix and public parts of the token.Example: dt0g02.4KWZO5EF| |seedToken|boolean|The token is a seed token (true) or an individual token (false).Example: false| |token*required|string|The secret of the token. Make sure to copy it-—-you won't be able to retrieve it again.Example: dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E|

ActiveGateTokenList

A list of ActiveGate tokens.

| Name | Type | Description | | --- | --- | --- | |activeGateTokens*required|Array<ActiveGateToken>|A list of ActiveGate tokens.| |nextPageKey|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==| |pageSize|number|The number of entries per page.Example: 100| |totalCount*required|string|The total number of entries in the result.Example: 1000|

ConnectionInfo

Connection info with tenant data and initial tenant endpoint

| Name | Type | Description | | --- | --- | --- | |initialEndpoint|string|Initial tenant endpoint.| |tenantToken|string|Tenant token.| |tenantUUID|string|Tenant UUID.|

ConstraintViolation

A list of constraint violations

| Name | Type | | --- | --- | |location|string| |message|string| |parameterLocation|"HEADER" | "PATH" | "PAYLOAD_BODY" | "QUERY"| |path|string|

ContainerImageComponent

Information about component type and images registry URI.

| Name | Type | Description | | --- | --- | --- | |imageUri|string|Registry URI of the container image component.| |type|"activegate" | "codemodules" | "database-datasource-executor" | "dynatrace-sql-extension-executor" | "eec" | "logmodule" | "oneagent"|Container image component type.|

ContainerImageData

Information about images registry and components with URI.

| Name | Type | Description | | --- | --- | --- | |components*required|Array<ContainerImageComponent>|List of container image components.| |registry|string|Registry name containing container images.|

Error

| Name | Type | Description | | --- | --- | --- | |code|number|The HTTP status code| |constraintViolations|Array<ConstraintViolation>|A list of constraint violations| |message|string|The error message|

ErrorEnvelope

| Name | Type | | --- | --- | |error|Error|

NetworkAddresses

List of Dynatrace addresses

| Name | Type | Description | | --- | --- | --- | |addresses*required|Array<string>|List of Dynatrace addresses.| |nextPageKey|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==| |pageSize|number|The number of entries per page.Example: 100| |totalCount*required|string|The total number of entries in the result.Example: 1000|

ResourceStatus

Lifecycle status of a long-running operation resource.

| Name | Type | Description | | --- | --- | --- | |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.|

StartSupportArchiveRequest

Request to start collecting a support archive.

| Name | Type | Description | | --- | --- | --- | |description*required|string|A description for the support archive.| |lookbackDays*required|number|The number of days to look back for log data.Minimum: 1|

StartSupportArchiveResponse

Response after starting a support archive collection.

| Name | Type | Description | | --- | --- | --- | |id*required|string|The ID of the newly created support archive.|

SupportArchive

Represents a support archive.

| Name | Type | Description | | --- | --- | --- | |collectedBy*required|string|The user who triggered the collection.| |collectionTimestamp|Date|The ISO 8601 UTC timestamp when the archive was collected. Null while the archive is still being collected.| |description*required|string|User-provided description.| |id*required|string|The support archive ID.| |lookbackDays*required|number|The lookback duration in days.| |resourceStatus*required|ResourceStatus|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*required|string|The Smartscape node ID of the entity.|

SupportArchiveListResponse

A list of support archives.

| Name | Type | Description | | --- | --- | --- | |items*required|Array<SupportArchive>|The list of support archives.| |nextPageKey|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==| |pageSize|number|The number of entries per page.Example: 100| |totalCount*required|string|The total number of entries in the result.Example: 1000|

Enums

~~ConstraintViolationParameterLocation~~

⚠️ Deprecated Use literal values.

Enum keys

Header | Path | PayloadBody | Query

~~ContainerImageComponentType~~

⚠️ Deprecated Use literal values.

Container image component type.

Enum keys

Activegate | Codemodules | DatabaseDatasourceExecutor | DynatraceSqlExtensionExecutor | Eec | Logmodule | Oneagent

~~DownloadActiveGateInstallerByVersionPathArch~~

⚠️ Deprecated Use literal values.

Enum keys

All | Amd64 | Arm64 | S390

~~DownloadActiveGateInstallerByVersionPathOsType~~

⚠️ Deprecated Use literal values.

Enum keys

Unix | Windows

~~DownloadLatestActiveGateInstallerPathArch~~

⚠️ Deprecated Use literal values.

Enum keys

All | Amd64 | Arm64 | S390

~~DownloadLatestActiveGateInstallerPathOsType~~

⚠️ Deprecated Use literal values.

Enum keys

Unix | Windows

~~ResourceStatusStatus~~

⚠️ Deprecated Use literal values.

The current lifecycle status of the resource.

Enum keys

AnalyzingArchive | AnalyzingDone | AnalyzingFailed | Canceled | CollectError | CollectInProgress | Collected | DeleteError | DeleteInProgress | Deleted | ManualCleanup | ReanalyzingNeeded | SendingFailed | SendingInProgress | SentToDynatraceCloud