@dynatrace-sdk/client-extensions-v2

v3.1.0

Published

a month ago

[![npm](https://img.shields.io/badge/npm-v3.1.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-extensions-v2/v/3.1.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

0High
0Medium
0Low

dynatrace-nodejs

stefan.wolfsteiner.dynatrace

wasserb

@dynatrace-sdk/client-extensions-v2

Documentation of Extensions 2.0 API.

Installation

npm install @dynatrace-sdk/client-extensions-v2

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.

discoveryClient

import { discoveryClient } from '@dynatrace-sdk/client-extensions-v2';

getJmxProcess

Retrieves details of a specified Java process discovered in the environment for JMX metric collection. | maturity=EARLY_ADOPTER

Required scope: extensions:discovery.jmx:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.filter|string|The filter parameter, as explained here. Filtering is supported on the following field: hostId - the ID of the host the process is running on, in the form HOST-XXXXXXXXXXXXXXXX. If the parameter is omitted, all processes are returned. Example: hostId = 'HOST-1234ABCD5678EFAB' | |config.processId*required|string|Id of the Java process discovered in the environment for JMX metric collection. |

Returns

| Return type | Status code | Description | |---|---|---| |JavaProcessDetails|200|Success.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Failed. Agent data isn't yet available. Try again in a few seconds. | Failed. Agent communication timeout. | Client error. | Server error.|

import { discoveryClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await discoveryClient.getJmxProcess({
  processId: "...",
});

listJmxProcesses

Lists all Java processes discovered in the environment that are available for JMX metric collection. | maturity=EARLY_ADOPTER

Required scope: extensions:discovery.jmx:read

Parameters

Returns

| Return type | Status code | Description | |---|---|---| |JavaProcessContainerList|200|Success.|

Throws

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

import { discoveryClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await discoveryClient.listJmxProcesses();

extensionsClient

import { extensionsClient } from '@dynatrace-sdk/client-extensions-v2';

activateExtensionEnvironmentConfiguration

Activates the environment configuration for a specified version of Extension 2.0.

Required scope: extensions:definitions:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|ExtensionEnvironmentConfigurationVersion| | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionEnvironmentConfigurationVersion|200|Success. Environment configuration created.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.activateExtensionEnvironmentConfiguration(
    { extensionName: "...", body: { version: "1.2.3" } },
  );

createExtensionMonitoringConfiguration

Creates a new monitoring configuration for Extension 2.0.

Required scope: extensions:configurations:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|MonitoringConfiguration| | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |MonitoringConfigurationResponse|201|Created.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.createExtensionMonitoringConfiguration(
    {
      extensionName: "...",
      body: { scope: "HOST-D3A3C5A146830A79" },
    },
  );

deleteExtensionEnvironmentConfiguration

Deactivates the environment configuration for Extension 2.0.

Required scope: extensions:definitions:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

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

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.deleteExtensionEnvironmentConfiguration(
    { extensionName: "..." },
  );

deleteExtensionMonitoringConfiguration

Deletes a specified monitoring configuration for Extension 2.0.

Required scope: extensions:configurations:write

Parameters

Returns

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

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.deleteExtensionMonitoringConfiguration(
    { extensionName: "...", configurationId: "..." },
  );

deleteExtensionVersion

Deletes a specified version of Extension 2.0.

Required scope: extensions:definitions:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.extensionName*required|string|The name of the requested Extension 2.0. | |config.extensionVersion*required|string|The version of the requested Extension 2.0 |

Returns

| Return type | Status code | Description | |---|---|---| |Extension|202|Accepted.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.deleteExtensionVersion({
  extensionName: "...",
  extensionVersion: "...",
});

executeExtensionMonitoringConfigurationActions

Executes data source actions on ActiveGate or Host for a specified monitoring configuration of Extension 2.0.

Required scope: extensions:configuration.actions:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|ExecuteActions| | |config.configurationId*required|string|The ID of the requested monitoring configuration. | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |ExecuteActionsResponse|202|Accepted.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.executeExtensionMonitoringConfigurationActions(
    {
      extensionName: "...",
      configurationId: "...",
      body: {},
    },
  );

getActiveExtensionEnvironmentConfiguration

Retrieves the active environment configuration version for Extension 2.0.

Required scope: extensions:definitions:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.addFields|string|Comma separated list of additional fields to include in the response. Available fields: assets - includes assets of the Extension 2.0 in the environment. status - includes installation status of assets of the Extension 2.0 in the environment. errors - includes installation errors of assets of the Extension 2.0 in the environment. | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |EnvironmentConfiguration|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.getActiveExtensionEnvironmentConfiguration(
    { extensionName: "..." },
  );

getActiveGateGroups

Lists all ActiveGate groups available for Extension 2.0.

Required scope: extensions:configurations:read

Parameters

Returns

| Return type | Status code | Description | |---|---|---| |ActiveGateGroupInfoList|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.getActiveGateGroups({
  extensionName: "...",
  extensionVersion: "...",
});

getAlertTemplate

Retrieves the alert template for a specified asset of the active environment configuration for Extension 2.0.

Required scope: extensions:definitions:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.alertTemplateId*required|string|ID of the requested asset. | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |AlertTemplate|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.getAlertTemplate({
  extensionName: "...",
  alertTemplateId: "...",
});

getExtensionConfigurationSchema

Retrieves the configuration schema for a specified version of Extension 2.0.

One of the following scopes is required:

extensions:definitions:read
extensions:configurations:read

Parameters

Returns

| Return type | Status code | Description | |---|---|---| |SchemaDefinitionRestDto|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.getExtensionConfigurationSchema({
    extensionName: "...",
    extensionVersion: "...",
  });

getExtensionDetails

Retrieves details of a specified version of Extension 2.0.

Required scope: extensions:definitions:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.acceptType*required|"application/json; charset=utf-8"| | |config.extensionName*required|string|The name of the requested Extension 2.0. | |config.extensionVersion*required|string|The version of the requested Extension 2.0 |

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Success.|

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.getExtensionDetails({
  acceptType: "application/json; charset=utf-8",
  extensionName: "...",
  extensionVersion: "...",
});

Parameters

| Name | Type | Description | | --- | --- | --- | |config.acceptType*required|"application/octet-stream" | "application/yaml"| | |config.extensionName*required|string|The name of the requested Extension 2.0. | |config.extensionVersion*required|string|The version of the requested Extension 2.0 |

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Success.|

getExtensionMonitoringConfigurationAudit

Retrieves the audit logs for a specified monitoring configuration of Extension 2.0.

Required scope: extensions:configurations:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.configurationId*required|string|The ID of the requested monitoring configuration. | |config.extensionName*required|string|The name of the requested Extension 2.0. | |config.from|string|The start of the requested timeframe. 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 relative timeframe of two weeks is used (now-2w). | |config.pageKey|string|The cursor for the next page of results. You can find it in the next-page-key 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 extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. | |config.sort*required|string|The sorting of audit log entries: timestamp: Oldest first. -timestamp: Newest first. If not set, the newest first sorting is applied. | |config.to|string|The end of the requested timeframe. 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 current timestamp is used. |

Returns

| Return type | Status code | Description | |---|---|---| |AuditLog|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.getExtensionMonitoringConfigurationAudit(
    {
      extensionName: "...",
      configurationId: "...",
      sort: "-timestamp",
    },
  );

getExtensionMonitoringConfigurationDetails

Retrieves details of a specified monitoring configuration for Extension 2.0.

Required scope: extensions:configurations:read

Parameters

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionMonitoringConfiguration|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.getExtensionMonitoringConfigurationDetails(
    { extensionName: "...", configurationId: "..." },
  );

getExtensionMonitoringConfigurationStatus

Retrieves the most recent execution status of a specified monitoring configuration for Extension 2.0.

Required scope: extensions:configurations:read

Parameters

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionStatus|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.getExtensionMonitoringConfigurationStatus(
    { extensionName: "...", configurationId: "..." },
  );

getExtensionMonitoringConfigurationStatuses

Retrieves the most recent execution statuses of monitoring configurations for Extension 2.0.

Required scope: extensions:configurations:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionStatusWithIdList|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.getExtensionMonitoringConfigurationStatuses(
    { extensionName: "..." },
  );

installExtension

Installs an Extension 2.0 from the Hub.

Required scope: extensions:definitions:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.extensionName*required|string|The name of the requested Extension 2.0. | |config.version|string|The version of Extension 2.0 to install. If not specified, the recommended version from the Dynatrace Hub shall be installed. |

Returns

| Return type | Status code | Description | |---|---|---| |RegisteredExtensionResult|202|Accepted.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.installExtension({
  extensionName: "...",
});

listExtensionMonitoringConfigurations

Lists all monitoring configurations for Extension 2.0.

Required scope: extensions:configurations:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.extensionName*required|string|The name of the requested Extension 2.0. | |config.filter|string|The filter parameter, as explained here. Filtering is supported on the following fields: version active or enabled (both keywords are supported and interchangeable) description activationContext | |config.pageKey|string|The cursor for the next page of results. You can find it in the next-page-key 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 monitoring configurations in a single response payload. The maximal allowed page size is 500. If not set, 20 is used. |

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionMonitoringConfigurationList|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.listExtensionMonitoringConfigurations(
    { extensionName: "..." },
  );

listExtensionVersions

Lists all versions of an Extension 2.0.

Required scope: extensions:definitions:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.extensionName*required|string|The name of the requested Extension 2.0. | |config.pageKey|string|The cursor for the next page of results. You can find it in the next-page-key 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 extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. |

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionList|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.listExtensionVersions({
  extensionName: "...",
});

listExtensions

Lists all Extensions 2.0 available in the environment.

Required scope: extensions:definitions:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.addFields|string|Comma separated list of additional fields to include in the response. Available fields: activeVersion - includes the active version of the Extension 2.0 in the environment. keywords - includes the keywords of the Extension 2.0. markedForDeletion - includes the markedForDeletion flag of the Extension 2.0 in the environment, which indicates that the extension is being deleted and cannot be updated or installed until the deletion process is completed. | |config.filter|string|The filter parameter, as explained here. Filtering is supported on the following fields: name markedForDeletion This filter supports all type operators as well as logical operators 'AND' and 'OR'. 'NOT' operator and parentheses aren't supported. | |config.pageKey|string|The cursor for the next page of results. You can find it in the next-page-key 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 extensions in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. |

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionInfoList|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.listExtensions();

updateExtensionEnvironmentConfiguration

Updates the active environment configuration version for Extension 2.0.

Required scope: extensions:definitions:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|ExtensionEnvironmentConfigurationVersion| | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionEnvironmentConfigurationVersion|200|Success. Environment configuration updated.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.updateExtensionEnvironmentConfiguration(
    { extensionName: "...", body: { version: "1.2.3" } },
  );

updateExtensionMonitoringConfiguration

Updates a specified monitoring configuration for Extension 2.0.

Required scope: extensions:configurations:write

Parameters

| Name | Type | Description | | --- | --- | --- | |config.body*required|MonitoringConfigurationUpdate| | |config.configurationId*required|string|The ID of the requested monitoring configuration. | |config.extensionName*required|string|The name of the requested Extension 2.0. |

Returns

| Return type | Status code | Description | |---|---|---| |MonitoringConfigurationResponse|200|Success.|

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data =
  await extensionsClient.updateExtensionMonitoringConfiguration(
    {
      extensionName: "...",
      configurationId: "...",
      body: {},
    },
  );

uploadExtension

Uploads a new Extension 2.0.

Required scope: extensions:definitions:write

Parameters

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

Returns

| Return type | Status code | Description | |---|---|---| |ExtensionUploadResponse|201|Success. Extension 2.0 has been uploaded.|

Throws

| Error Type | Error Message | |---|---| |ErrorEnvelopeError|Failed. The input file is invalid. | Upload isn't possible yet. Try again in a few seconds. | Client error. | Server error.|

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.uploadExtension({
  body: new Blob(),
});

validateExtension

Verifies a new Extension 2.0 for lack of any errors. Performs the same set of operations as upload but doesn't persist the changes.

Required scope: extensions:definitions:write

Parameters

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

Returns

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

Throws

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

import { extensionsClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await extensionsClient.validateExtension({
  body: new Blob(),
});

schemasClient

import { schemasClient } from '@dynatrace-sdk/client-extensions-v2';

getSchemaVersionFile

Retrieves the schema file for a specified schema version of Extension 2.0.

Required scope: extensions:definitions:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.fileName*required|string|The name of the schema file. | |config.schemaVersion*required|string|The version of the schema. |

Returns

| Return type | Status code | Description | |---|---|---| |JsonNode|200|Success.|

Throws

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

import { schemasClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await schemasClient.getSchemaVersionFile({
  schemaVersion: "...",
  fileName: "...",
});

listSchemaVersionFiles

Lists all schema files for a specified schema version of Extension 2.0.

Required scope: extensions:definitions:read

Parameters

| Name | Type | Description | | --- | --- | --- | |config.acceptType*required|"application/json; charset=utf-8"| | |config.schemaVersion*required|string|The version of the schema. |

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Success.|

import { schemasClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await schemasClient.listSchemaVersionFiles({
  acceptType: "application/json; charset=utf-8",
  schemaVersion: "...",
});

Parameters

| Name | Type | Description | | --- | --- | --- | |config.acceptType*required|"application/octet-stream"| | |config.schemaVersion*required|string|The version of the schema. |

Returns

| Return type | Status code | Description | |---|---|---| |void|200|Success.|

listSchemaVersions

Lists all schema versions of Extension 2.0 available in the environment.

Required scope: extensions:definitions:read

Returns

| Return type | Status code | Description | |---|---|---| |SchemaVersionList|200|Success.|

Throws

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

import { schemasClient } from "@dynatrace-sdk/client-extensions-v2";

const data = await schemasClient.listSchemaVersions();

Types

ActiveGateGroupInfo

Metadata for each ActiveGate group.

| Name | Type | Description | | --- | --- | --- | |activeGates*required|Array<ActiveGateInfo>|ActiveGates in group. | |availableActiveGates*required|number|Number of ActiveGates in group available for extension. | |groupName*required|string|ActiveGate group name. |

ActiveGateGroupInfoList

ActiveGate groups metadata for extensions.

| Name | Type | Description | | --- | --- | --- | |items*required|Array<ActiveGateGroupInfo>|Metadata for each ActiveGate group. |

ActiveGateInfo

ActiveGates in group.

| Name | Type | Description | | --- | --- | --- | |errors*required|Array<string>|List of errors if Extension can't be run on the ActiveGate | |id*required|string|ActiveGate ID. |

AlertTemplate

| Name | Type | | --- | --- | |templateJson|string|

AssetInfo

Metadata for an extension asset.

| Name | Type | Description | | --- | --- | --- | |assetSchemaDetails|AssetSchemaDetails|Settings schema details for asset | |displayName|string|User-friendly name of the asset. | |id|string|ID of the asset. Identifies the asset in REST API and/or UI (where applicable). | |type|"ALERT" | "ALERT_TEMPLATE" | "AWS_SERVICE" | "CUSTOM_CARDS" | "DASHBOARD" | "DECLARATIVE_PROCESSES" | "DOCUMENT_DASHBOARD" | "DQL_LOG_METRIC" | "DQL_LOG_PROCESSING_RULE" | "GENERIC_RELATIONSHIP" | "GENERIC_TYPE" | "LIST_SCREEN_FILTERS" | "LIST_SCREEN_INJECTIONS" | "LIST_SCREEN_LAYOUT" | "LOG_EVENT" | "LOG_METRIC" | "LOG_PROCESSING_RULE" | "LQL_LOG_METRIC" | "LQL_LOG_PROCESSING_RULE" | "METRIC_METADATA" | "METRIC_QUERY" | "OPEN_PIPELINE" | "PROCESS_GROUPING_RULES" | "SCREEN_ACTIONS" | "SCREEN_CHART_GROUPS" | "SCREEN_DQL_TABLE" | "SCREEN_ENTITIES_LISTS" | "SCREEN_EVENTS_CARDS" | "SCREEN_FILTERS" | "SCREEN_HEALTH_CARDS" | "SCREEN_INJECTIONS" | "SCREEN_LAYOUT" | "SCREEN_LOGS_CARDS" | "SCREEN_MESSAGE_CARDS" | "SCREEN_METRIC_TABLES" | "SCREEN_PROBLEMS" | "SCREEN_PROPERTIES"|The type of the asset. |

AssetSchemaDetails

Settings schema details for asset

| Name | Type | Description | | --- | --- | --- | |key|string|Asset key | |schemaId|string|Asset schema id | |scope|string|Asset configuration scope |

AuditLog

The audit log of your environment.

| Name | Type | Description | | --- | --- | --- | |auditLogs|Array<AuditLogEntry>|A list of audit log entries ordered by the creation timestamp. | |nextPageKey|string|The cursor for the next page of results. Has the value of null on the last page. Use it in the nextPageKey query parameter to obtain subsequent pages of the result. | |pageSize|number|The number of entries per page. | |totalCount*required|number|The total number of entries in the result. |

AuditLogEntry

An entry of the audit log.

| Name | Type | Description | | --- | --- | --- | |category*required|"ACTIVEGATE_TOKEN" | "BUILD_UNIT_V2" | "CONFIG" | "MANUAL_TAGGING_SERVICE" | "TENANT_LIFECYCLE" | "TOKEN" | "WEB_UI"|The category of the recorded operation. | |dt.settings.key|string|The key of the affected object of a setting for entries of category CONFIG. | |dt.settings.object_id|string|The ID of the affected object of a setting for entries of category CONFIG. | |dt.settings.object_summary|string|The value summary for entries of category CONFIG. | |dt.settings.schema_id|string|The schema ID or config ID for entries of category CONFIG. | |dt.settings.scope_id|string|The persistence scope for entries of category CONFIG, e.g. an ME identifier. | |dt.settings.scope_name|string|The display name of the scope for entries of category CONFIG. | |entityId|string|The ID of an entity from the category. For example, it can be config ID for the CONFIG category or token ID for the TOKEN category. | |environmentId*required|string|The ID of the Dynatrace environment where the recorded operation occurred. | |eventType*required|"CREATE" | "DELETE" | "LOGIN" | "LOGOUT" | "REORDER" | "REVOKE" | "TAG_ADD" | "TAG_REMOVE" | "TAG_UPDATE" | "UPDATE"|The type of the recorded operation. LOGIN -> A user logged in LOGOUT -> A user logged out CREATE -> An object was created UPDATE -> An object was updated DELETE -> An object was deleted REVOKE -> An Active Gate token was revoked TAG_ADD -> A manual tag was added TAG_REMOVE -> A manual tag was removed TAG_UPDATE -> A manual tag was updated REMOTE_CONFIGURATION_MANAGEMENT -> A Remote Configuration Management related operation occurred | |logId*required|string|The ID of the log entry. | |message|string|The logged message. | |patch|any|The patch of the recorded operation as the JSON representation. The format is an enhanced RFC 6902. The patch also carries the previous value in the oldValue field. | |success*required|boolean|The recorded operation is successful (true) or failed (false). | |timestamp*required|number|The timestamp of the record creation, in UTC milliseconds. | |user*required|string|The ID of the user who performed the recorded operation. | |userOrigin|string|The origin and the IP address of the user. | |userType*required|"PUBLIC_TOKEN_IDENTIFIER" | "SERVICE_NAME" | "TOKEN_HASH" | "USER_NAME"|The type of the authentication of the user. USER_NAME -> User was logged in the UI TOKEN_HASH -> URL Token or DevOps Token, the hash of the token is logged SERVICE_NAME -> No authenticated user at all, this action was performed by a system service automatically PUBLIC_TOKEN_IDENTIFIER -> API Token, the public token id is logged |

Author

Extension author

| Name | Type | Description | | --- | --- | --- | |name|string|Author name |

ComplexConstraint

A constraint on the values accepted for a complex settings property.

| Name | Type | Description | | --- | --- | --- | |checkAllProperties|boolean|Defines if modification of any property triggers secret resubmission check. | |customMessage|string|A custom message for invalid values. | |customValidatorId|string|The ID of a custom validator. | |maximumPropertyCount|number|The maximum number of properties that can be set. | |minimumPropertyCount|number|The minimum number of properties that must be set. | |properties|Array<string>|A list of properties (defined by IDs) that are used to check the constraint. | |skipAsyncValidation|boolean|Whether to skip validation on a change made from the UI. | |timeout|number|The maximum time in seconds the custom validator is allowed to run. | |type*required|"CUSTOM_VALIDATOR_REF" | "GREATER_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN" | "LESS_THAN_OR_EQUAL" | "PROPERTY_COUNT_RANGE" | "SECRET_RESUBMISSION" | "UNKNOWN"|The type of the constraint. |

Constraint

A constraint on the values accepted for a settings property.

| Name | Type | Description | | --- | --- | --- | |customMessage|string|A custom message for invalid values. | |customValidatorId|string|The ID of a custom validator. | |disallowDangerousRegex|boolean|Whether to disallow usage of dangerous regexes | |maxLength|number|The maximum allowed length of string values. | |maximum|number|The maximum allowed value. | |minLength|number|The minimum required length of string values. | |minimum|number|The minimum allowed value. | |pattern|string|The regular expression pattern for valid string values. | |skipAsyncValidation|boolean|Whether to skip validation on a change made from the UI. | |timeout|number|The maximum time in seconds the custom validator is allowed to run. | |type*required|"CUSTOM_VALIDATOR_REF" | "UNKNOWN" | "LENGTH" | "NOT_BLANK" | "NOT_EMPTY" | "NO_WHITESPACE" | "PATTERN" | "RANGE" | "REGEX" | "TRIMMED" | "UNIQUE"|The type of the constraint. | |uniqueProperties|Array<string>|A list of properties for which the combination of values must be unique. |

ConstraintViolation

A list of constraint violations.

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

DatasourceDefinition

Configuration of a datasource for a property.

| Name | Type | Description | | --- | --- | --- | |filterProperties*required|Array<string>|The properties to filter the datasource options on. | |fullContext*required|boolean|Whether this datasource expects full setting payload as the context. | |identifier*required|string|The identifier of a custom data source of the property's value. | |resetValue|"ALWAYS" | "INVALID_ONLY" | "NEVER"|When to reset datasource value in the UI on filter change. | |useApiSearch*required|boolean|If true, the datasource should use the api to filter the results instead of client-side filtering. | |validate*required|boolean|Whether to validate input to only allow values returned by the datasource. |

DeletionConstraint

A constraint on the values that are going to be deleted.

| Name | Type | Description | | --- | --- | --- | |customMessage|string|A custom message for invalid values. | |customValidatorId|string|The ID of a custom validator. | |schemaIds|Array<string>| | |timeout|number|The maximum time in seconds the custom validator is allowed to run. | |type*required|"CUSTOM_VALIDATOR_REF" | "UNKNOWN" | "REFERENTIAL_INTEGRITY"|The type of the deletion constraint. |

EnumType

Definition of an enum property.

| Name | Type | Description | | --- | --- | --- | |description*required|string|A short description of the property. | |displayName|string|The display name of the property. | |documentation*required|string|An extended description and/or links to documentation. | |enumClass|string|An existing Java enum class that holds the allowed values of the enum. | |items*required|Array<EnumValue>|A list of allowed values of the enum. | |type*required|"enum"|The type of the property. |

EnumValue

An allowed value for an enum property.

| Name | Type | Description | | --- | --- | --- | |description|string|A short description of the value. | |displayName*required|string|The display name of the value. | |enumInstance|string|The name of the value in an existing Java enum class. | |icon|string|The icon of the value. | |value*required|any|The allowed value of the enum. |

EnvironmentConfiguration

List of assets imported with the active extension environment configuration.

| Name | Type | Description | | --- | --- | --- | |assets*required|Array<AssetInfo>|The list of the imported assets. | |errors*required|Array<string>|List of errors during asset import | |status*required|"PENDING" | "UP_TO_DATE"|The status of the assets list. | |version*required|string|Version of the active extension environment configuration. Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?|

Error

| Name | Type | Description | | --- | --- | --- | |code|number|The HTTP status code. | |details|ErrorDetails|The error details. | |message|string|The error message. |

ErrorDetails

The error details.

| Name | Type | Description | | --- | --- | --- | |constraintViolations|Array<ConstraintViolation>|A list of constraint violations. |

ErrorEnvelope

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

ExecuteActions

| Name | Type | Description | | --- | --- | --- | |actions|ExecuteActionsActions|Data Source defined action objects |

ExecuteActionsActions

Data Source defined action objects

type: Record<string, JsonNode>

ExecuteActionsResponse

| Name | Type | Description | | --- | --- | --- | |~~activeGateId~~DEPRECATED|string|Active Gate id for actions execution | |activeGateIds|Array<string>|Active Gate ids for actions execution | |~~activeGateName~~DEPRECATED|string|Active Gate name for actions execution |

Extension

| Name | Type | Description | | --- | --- | --- | |author*required|Author|Extension author | |dataSources*required|Array<string>|Data sources that extension uses to gather data | |extensionName*required|string|Extension name | |featureSets*required|Array<string>|Available feature sets | |featureSetsDetails*required|ExtensionFeatureSetsDetails|Details of fea

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@dynatrace-sdk/client-extensions-v2

Installation

Getting help

License

API reference

discoveryClient

getJmxProcess

Parameters

Returns

Throws

listJmxProcesses

Parameters

Returns

Throws

extensionsClient

activateExtensionEnvironmentConfiguration

Parameters

Returns

Throws

createExtensionMonitoringConfiguration

Parameters

Returns

Throws

deleteExtensionEnvironmentConfiguration

Parameters

Returns

Throws

deleteExtensionMonitoringConfiguration

Parameters

Returns

Throws

deleteExtensionVersion

Parameters

Returns

Throws

executeExtensionMonitoringConfigurationActions

Parameters

Returns

Throws

getActiveExtensionEnvironmentConfiguration

Parameters

Returns

Throws

getActiveGateGroups

Parameters

Returns

Throws

getAlertTemplate

Parameters

Returns

Throws

getExtensionConfigurationSchema

Parameters

Returns

Throws

getExtensionDetails

Parameters

Returns

Parameters

Returns

getExtensionMonitoringConfigurationAudit

Parameters

Returns

Throws

getExtensionMonitoringConfigurationDetails

Parameters

Returns

Throws

getExtensionMonitoringConfigurationStatus

Parameters

Returns

Throws

getExtensionMonitoringConfigurationStatuses

Parameters