{"_id":"@dynatrace-sdk/client-extensions-v2","_rev":"2-71a1cf9759086252bab9fda8aeb1972d","name":"@dynatrace-sdk/client-extensions-v2","dist-tags":{"latest":"3.1.0"},"versions":{"3.0.0":{"name":"@dynatrace-sdk/client-extensions-v2","version":"3.0.0","license":"Apache-2.0","_id":"@dynatrace-sdk/client-extensions-v2@3.0.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"}],"dist":{"shasum":"8d8d6f8bdb6e73281b17e349565809078c21c3cc","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-extensions-v2/-/client-extensions-v2-3.0.0.tgz","fileCount":124,"integrity":"sha512-4yF5eRANVueOxdhHyoqyZZRlK8n+uV8q4kpB4O1WM25RdFwAu2QbS/LKNMcWEhGLUXlgeXMSw7ovUxrxuyuopA==","signatures":[{"sig":"MEUCIQDzDxUsj1nfoUgGm5J5EB4R740/CWPPFLA9RCA7AlDhNgIgYZC/ZYmDKOYqAmjfLjkPDXBib89ACeLM6rAqbdIGO+4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":521733},"main":"./cjs/index.js","_from":"file:dynatrace-sdk-client-extensions-v2-3.0.0.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-extensions-v2-3.0.0-w8gTso/dynatrace-sdk-client-extensions-v2-3.0.0.tgz","_integrity":"sha512-4yF5eRANVueOxdhHyoqyZZRlK8n+uV8q4kpB4O1WM25RdFwAu2QbS/LKNMcWEhGLUXlgeXMSw7ovUxrxuyuopA==","_npmVersion":"10.9.0","description":"[![npm](https://img.shields.io/badge/npm-v3.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-extensions-v2/v/3.0.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)","directories":{},"_nodeVersion":"22.10.0","dependencies":{"@dynatrace-sdk/http-client":"^1.4.0","@dynatrace-sdk/shared-errors":"^1.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/client-extensions-v2_3.0.0_1777466517831_0.06576912855472727","host":"s3://npm-registry-packages-npm-production"}},"3.1.0":{"name":"@dynatrace-sdk/client-extensions-v2","version":"3.1.0","dependencies":{"@dynatrace-sdk/http-client":"^1.4.0","@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-extensions-v2@3.1.0","description":"[![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)","_integrity":"sha512-TFk01MAWirQ7xjusmRb5X+ko64K+sP5kmmXKk6GrN8lE5bmsipcT86Y9ZYufWVi/oJHcnLGiFUdbdGom0pAV4Q==","_resolved":"/tmp/npm-publish-@dynatrace-sdk-client-extensions-v2-3.1.0-YgAUb6/dynatrace-sdk-client-extensions-v2-3.1.0.tgz","_from":"file:dynatrace-sdk-client-extensions-v2-3.1.0.tgz","_nodeVersion":"24.13.0","_npmVersion":"11.6.2","dist":{"integrity":"sha512-TFk01MAWirQ7xjusmRb5X+ko64K+sP5kmmXKk6GrN8lE5bmsipcT86Y9ZYufWVi/oJHcnLGiFUdbdGom0pAV4Q==","shasum":"2558f39a5fdf569065b1fc4174c57b76b873dcb1","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-extensions-v2/-/client-extensions-v2-3.1.0.tgz","fileCount":8,"unpackedSize":514863,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCZOnv89hY2KpME7oIV2SawWVxkCbLdhVHaeUmZpVZ06wIhAKSg0imlNi9XBkPRaDCPmxuaxlIgvCkm7S8Bo+/m4k3i"}]},"_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-extensions-v2_3.1.0_1778054795876_0.5862582994195524"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-29T12:41:57.619Z","modified":"2026-05-06T08:06:36.165Z","3.0.0":"2026-04-29T12:41:58.038Z","3.1.0":"2026-05-06T08:06:36.003Z"},"license":"Apache-2.0","description":"[![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)","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-extensions-v2\n\n[![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)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nDocumentation of Extensions 2.0 API.\n\n\n## Installation\n\n```bash\nnpm install @dynatrace-sdk/client-extensions-v2\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-extensions-v2/).\n\n## discoveryClient\n\n```js\nimport { discoveryClient } from '@dynatrace-sdk/client-extensions-v2';\n```\n\n\n<a name=\"getjmxprocess\"></a>\n### getJmxProcess\n\n<div class=\"padding-bottom--md\">\n<strong>discoveryClient.getJmxProcess(config): Promise&lt;JavaProcessDetails&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves details of a specified Java process discovered in the environment for JMX metric collection. | maturity=EARLY_ADOPTER\n\n**Required scope:** extensions:discovery.jmx:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href=\"https://dt-url.net/platform-services-filtering\" target=\"_blank\" rel=\"noopener noreferrer\" >here</a>.</p> <p>Filtering is supported on the following field:</p> <ul> <li><code>hostId</code> - the ID of the host the process is running on, in the form <code>HOST-XXXXXXXXXXXXXXXX</code>.</li> </ul> <p>If the parameter is omitted, all processes are returned.</p> <p>Example: <code>hostId = 'HOST-1234ABCD5678EFAB'</code></p>  |\n|config.processId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the Java process discovered in the environment for JMX metric collection. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[JavaProcessDetails](#javaprocessdetails)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Failed. Agent data isn't yet available. Try again in a few seconds. &#124; Failed. Agent communication timeout. &#124; Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { discoveryClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await discoveryClient.getJmxProcess({\n  processId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"listjmxprocesses\"></a>\n### listJmxProcesses\n\n<div class=\"padding-bottom--md\">\n<strong>discoveryClient.listJmxProcesses(config): Promise&lt;<a href=\"#javaprocesscontainerlist\">JavaProcessContainerList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all Java processes discovered in the environment that are available for JMX metric collection. | maturity=EARLY_ADOPTER\n\n**Required scope:** extensions:discovery.jmx:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href=\"https://dt-url.net/platform-services-filtering\" target=\"_blank\" rel=\"noopener noreferrer\" >here</a>.</p> <p>Filtering is supported on the following field:</p> <ul> <li><code>hostId</code> - the ID of the host the process is running on, in the form <code>HOST-XXXXXXXXXXXXXXXX</code>.</li> </ul> <p>If the parameter is omitted, all processes are returned.</p> <p>Example: <code>hostId = 'HOST-1234ABCD5678EFAB'</code></p>  |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[JavaProcessContainerList](#javaprocesscontainerlist)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { discoveryClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await discoveryClient.listJmxProcesses();\n```\n\n</details>\n\n\n\n</div>\n\n## extensionsClient\n\n```js\nimport { extensionsClient } from '@dynatrace-sdk/client-extensions-v2';\n```\n\n\n<a name=\"activateextensionenvironmentconfiguration\"></a>\n### activateExtensionEnvironmentConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.activateExtensionEnvironmentConfiguration(config): Promise&lt;<a href=\"#extensionenvironmentconfigurationversion\" target=\"_blank\" rel=\"noopener noreferrer\">ExtensionEnvironmentConfigurationVersion</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nActivates the environment configuration for a specified version of Extension 2.0.\n\n**Required scope:** extensions:definitions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#extensionenvironmentconfigurationversion\">ExtensionEnvironmentConfigurationVersion</a>| |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionEnvironmentConfigurationVersion](#extensionenvironmentconfigurationversion)|200|Success. Environment configuration created.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.activateExtensionEnvironmentConfiguration(\n    { extensionName: \"...\", body: { version: \"1.2.3\" } },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"createextensionmonitoringconfiguration\"></a>\n### createExtensionMonitoringConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.createExtensionMonitoringConfiguration(config): Promise&lt;<a href=\"#monitoringconfigurationresponse\" target=\"_blank\" rel=\"noopener noreferrer\">MonitoringConfigurationResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nCreates a new monitoring configuration for Extension 2.0.\n\n**Required scope:** extensions:configurations:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#monitoringconfiguration\">MonitoringConfiguration</a>| |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[MonitoringConfigurationResponse](#monitoringconfigurationresponse)|201|Created.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.createExtensionMonitoringConfiguration(\n    {\n      extensionName: \"...\",\n      body: { scope: \"HOST-D3A3C5A146830A79\" },\n    },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"deleteextensionenvironmentconfiguration\"></a>\n### deleteExtensionEnvironmentConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.deleteExtensionEnvironmentConfiguration(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nDeactivates the environment configuration for Extension 2.0.\n\n**Required scope:** extensions:definitions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Environment configuration deactivated. Response doesn&apos;t have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.deleteExtensionEnvironmentConfiguration(\n    { extensionName: \"...\" },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"deleteextensionmonitoringconfiguration\"></a>\n### deleteExtensionMonitoringConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.deleteExtensionMonitoringConfiguration(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nDeletes a specified monitoring configuration for Extension 2.0.\n\n**Required scope:** extensions:configurations:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Response doesn&apos;t have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.deleteExtensionMonitoringConfiguration(\n    { extensionName: \"...\", configurationId: \"...\" },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"deleteextensionversion\"></a>\n### deleteExtensionVersion\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.deleteExtensionVersion(config): Promise&lt;<a href=\"#extension\" target=\"_blank\" rel=\"noopener noreferrer\">Extension</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nDeletes a specified version of Extension 2.0.\n\n**Required scope:** extensions:definitions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested Extension 2.0 |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[Extension](#extension)|202|Accepted.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.deleteExtensionVersion({\n  extensionName: \"...\",\n  extensionVersion: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"executeextensionmonitoringconfigurationactions\"></a>\n### executeExtensionMonitoringConfigurationActions\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.executeExtensionMonitoringConfigurationActions(config): Promise&lt;<a href=\"#executeactionsresponse\">ExecuteActionsResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nExecutes data source actions on ActiveGate or Host for a specified monitoring configuration of Extension 2.0.\n\n**Required scope:** extensions:configuration.actions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#executeactions\" target=\"_blank\" rel=\"noopener noreferrer\">ExecuteActions</a>| |\n|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExecuteActionsResponse](#executeactionsresponse)|202|Accepted.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.executeExtensionMonitoringConfigurationActions(\n    {\n      extensionName: \"...\",\n      configurationId: \"...\",\n      body: {},\n    },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getactiveextensionenvironmentconfiguration\"></a>\n### getActiveExtensionEnvironmentConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getActiveExtensionEnvironmentConfiguration(config): Promise&lt;<a href=\"#environmentconfiguration\">EnvironmentConfiguration</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves the active environment configuration version for Extension 2.0.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.addFields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Comma separated list of additional fields to include in the response. Available fields:</p> <ul> <li><code>assets</code> - includes assets of the Extension 2.0 in the environment.</li> <li><code>status</code> - includes installation status of assets of the Extension 2.0 in the environment.</li> <li><code>errors</code> - includes installation errors of assets of the Extension 2.0 in the environment.</li> </ul>  |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[EnvironmentConfiguration](#environmentconfiguration)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.getActiveExtensionEnvironmentConfiguration(\n    { extensionName: \"...\" },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getactivegategroups\"></a>\n### getActiveGateGroups\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getActiveGateGroups(config): Promise&lt;<a href=\"#activegategroupinfolist\" target=\"_blank\" rel=\"noopener noreferrer\">ActiveGateGroupInfoList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all ActiveGate groups available for Extension 2.0.\n\n**Required scope:** extensions:configurations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested Extension 2.0 |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ActiveGateGroupInfoList](#activegategroupinfolist)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.getActiveGateGroups({\n  extensionName: \"...\",\n  extensionVersion: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getalerttemplate\"></a>\n### getAlertTemplate\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getAlertTemplate(config): Promise&lt;<a href=\"#alerttemplate\">AlertTemplate</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves the alert template for a specified asset of the active environment configuration for Extension 2.0.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.alertTemplateId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ID of the requested asset. |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AlertTemplate](#alerttemplate)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.getAlertTemplate({\n  extensionName: \"...\",\n  alertTemplateId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getextensionconfigurationschema\"></a>\n### getExtensionConfigurationSchema\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getExtensionConfigurationSchema(config): Promise&lt;<a href=\"#schemadefinitionrestdto\" target=\"_blank\" rel=\"noopener noreferrer\">SchemaDefinitionRestDto</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves the configuration schema for a specified version of Extension 2.0.\n\n**One of the following scopes is required:**\n+ extensions:definitions:read\n+ extensions:configurations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested Extension 2.0 |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SchemaDefinitionRestDto](#schemadefinitionrestdto)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.getExtensionConfigurationSchema({\n    extensionName: \"...\",\n    extensionVersion: \"...\",\n  });\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getextensiondetails\"></a>\n### getExtensionDetails\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getExtensionDetails(config): Promise&lt;<a href=\"#extension\">Extension</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves details of a specified version of Extension 2.0.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.acceptType<sup>*required</sup>|\"application/json; charset=utf-8\"| |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested Extension 2.0 |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success.|\n\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.getExtensionDetails({\n  acceptType: \"application/json; charset=utf-8\",\n  extensionName: \"...\",\n  extensionVersion: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getExtensionDetails(config): Promise&lt;Binary&gt;</strong>\n\n<div class=\"padding-left--md\">\n\n\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.acceptType<sup>*required</sup>|\"application/octet-stream\" &#124; \"application/yaml\"| |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.extensionVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the requested Extension 2.0 |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success.|\n\n\n\n\n\n</div>\n\n\n<a name=\"getextensionmonitoringconfigurationaudit\"></a>\n### getExtensionMonitoringConfigurationAudit\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getExtensionMonitoringConfigurationAudit(config): Promise&lt;<a href=\"#auditlog\" target=\"_blank\" rel=\"noopener noreferrer\">AuditLog</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves the audit logs for a specified monitoring configuration of Extension 2.0.\n\n**Required scope:** extensions:configurations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The start of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the relative timeframe of two weeks is used (<code>now-2w</code>).</p>  |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>next-page-key</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>page-key</strong> query parameter.</p> <p>When the <strong>page-key</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p>  |\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of extensions in a single response payload.</p> <p>The maximal allowed page size is 100.</p> <p>If not set, 20 is used.</p>  |\n|config.sort<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The sorting of audit log entries:</p> <ul> <li><code>timestamp</code>: Oldest first.</li> <li><code>-timestamp</code>: Newest first.</li> </ul> <p>If not set, the newest first sorting is applied.</p>  |\n|config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The end of the requested timeframe.</p> <p>You can use one of the following formats:</p> <ul> <li>Timestamp in UTC milliseconds.</li> <li>Human-readable format of <code>2021-01-25T05:57:01.123+01:00</code>. If no time zone is specified, UTC is used. You can use a space character instead of the <code>T</code>. Seconds and fractions of a second are optional.</li> <li>Relative timeframe, back from now. The format is <code>now-NU/A</code>, where <code>N</code> is the amount of time, <code>U</code> is the unit of time, and <code>A</code> is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, <code>now-1y/w</code> is one year back, aligned by a week. You can also specify relative timeframe without an alignment: <code>now-NU</code>. Supported time units for the relative timeframe are: <ul> <li><code>m</code>: minutes</li> <li><code>h</code>: hours</li> <li><code>d</code>: days</li> <li><code>w</code>: weeks</li> <li><code>M</code>: months</li> <li><code>y</code>: years</li> </ul> </li> </ul> <p>If not set, the current timestamp is used.</p>  |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AuditLog](#auditlog)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.getExtensionMonitoringConfigurationAudit(\n    {\n      extensionName: \"...\",\n      configurationId: \"...\",\n      sort: \"-timestamp\",\n    },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getextensionmonitoringconfigurationdetails\"></a>\n### getExtensionMonitoringConfigurationDetails\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getExtensionMonitoringConfigurationDetails(config): Promise&lt;<a href=\"#extensionmonitoringconfiguration\">ExtensionMonitoringConfiguration</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves details of a specified monitoring configuration for Extension 2.0.\n\n**Required scope:** extensions:configurations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionMonitoringConfiguration](#extensionmonitoringconfiguration)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.getExtensionMonitoringConfigurationDetails(\n    { extensionName: \"...\", configurationId: \"...\" },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getextensionmonitoringconfigurationstatus\"></a>\n### getExtensionMonitoringConfigurationStatus\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getExtensionMonitoringConfigurationStatus(config): Promise&lt;<a href=\"#extensionstatus\" target=\"_blank\" rel=\"noopener noreferrer\">ExtensionStatus</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves the most recent execution status of a specified monitoring configuration for Extension 2.0.\n\n**Required scope:** extensions:configurations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionStatus](#extensionstatus)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.getExtensionMonitoringConfigurationStatus(\n    { extensionName: \"...\", configurationId: \"...\" },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getextensionmonitoringconfigurationstatuses\"></a>\n### getExtensionMonitoringConfigurationStatuses\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.getExtensionMonitoringConfigurationStatuses(config): Promise&lt;<a href=\"#extensionstatuswithidlist\">ExtensionStatusWithIdList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves the most recent execution statuses of monitoring configurations for Extension 2.0.\n\n**Required scope:** extensions:configurations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionStatusWithIdList](#extensionstatuswithidlist)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.getExtensionMonitoringConfigurationStatuses(\n    { extensionName: \"...\" },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"installextension\"></a>\n### installExtension\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.installExtension(config): Promise&lt;<a href=\"#registeredextensionresult\" target=\"_blank\" rel=\"noopener noreferrer\">RegisteredExtensionResult</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nInstalls an Extension 2.0 from the Hub.\n\n**Required scope:** extensions:definitions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.version|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of Extension 2.0 to install. If not specified, the recommended version from the Dynatrace Hub shall be installed. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[RegisteredExtensionResult](#registeredextensionresult)|202|Accepted.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.installExtension({\n  extensionName: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"listextensionmonitoringconfigurations\"></a>\n### listExtensionMonitoringConfigurations\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.listExtensionMonitoringConfigurations(config): Promise&lt;<a href=\"#extensionmonitoringconfigurationlist\">ExtensionMonitoringConfigurationList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all monitoring configurations for Extension 2.0.\n\n**Required scope:** extensions:configurations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href=\"https://dt-url.net/platform-services-filtering\" target=\"_blank\" rel=\"noopener noreferrer\" >here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>version</code></li> <li><code>active</code> or <code>enabled</code> (both keywords are supported and interchangeable)</li> <li><code>description</code></li> <li><code>activationContext</code></li> </ul>  |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>next-page-key</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>page-key</strong> query parameter.</p> <p>When the <strong>page-key</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p>  |\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of monitoring configurations in a single response payload.</p> <p>The maximal allowed page size is 500.</p> <p>If not set, 20 is used.</p>  |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionMonitoringConfigurationList](#extensionmonitoringconfigurationlist)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.listExtensionMonitoringConfigurations(\n    { extensionName: \"...\" },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"listextensionversions\"></a>\n### listExtensionVersions\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.listExtensionVersions(config): Promise&lt;<a href=\"#extensionlist\" target=\"_blank\" rel=\"noopener noreferrer\">ExtensionList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all versions of an Extension 2.0.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>next-page-key</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>page-key</strong> query parameter.</p> <p>When the <strong>page-key</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p>  |\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of extensions in a single response payload.</p> <p>The maximal allowed page size is 100.</p> <p>If not set, 20 is used.</p>  |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionList](#extensionlist)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.listExtensionVersions({\n  extensionName: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"listextensions\"></a>\n### listExtensions\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.listExtensions(config): Promise&lt;<a href=\"#extensioninfolist\">ExtensionInfoList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all Extensions 2.0 available in the environment.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.addFields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Comma separated list of additional fields to include in the response. Available fields:</p> <ul> <li><code>activeVersion</code> - includes the active version of the Extension 2.0 in the environment.</li> <li><code>keywords</code> - includes the keywords of the Extension 2.0.</li> <li><code>markedForDeletion</code> - 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.</li> </ul>  |\n|config.filter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The filter parameter, as explained <a href=\"https://dt-url.net/platform-services-filtering\" target=\"_blank\" rel=\"noopener noreferrer\" >here</a>.</p> <p>Filtering is supported on the following fields:</p> <ul> <li><code>name</code></li> <li><code>markedForDeletion</code></li> </ul> <p>This filter supports all type operators as well as logical operators 'AND' and 'OR'. 'NOT' operator and parentheses aren't supported.</p>  |\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. You can find it in the <strong>next-page-key</strong> field of the previous response.</p> <p>The first page is always returned if you don't specify the <strong>page-key</strong> query parameter.</p> <p>When the <strong>page-key</strong> is set to obtain subsequent pages, you must omit all other query parameters.</p>  |\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|<p>The amount of extensions in a single response payload.</p> <p>The maximal allowed page size is 100.</p> <p>If not set, 20 is used.</p>  |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionInfoList](#extensioninfolist)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.listExtensions();\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"updateextensionenvironmentconfiguration\"></a>\n### updateExtensionEnvironmentConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.updateExtensionEnvironmentConfiguration(config): Promise&lt;<a href=\"#extensionenvironmentconfigurationversion\" target=\"_blank\" rel=\"noopener noreferrer\">ExtensionEnvironmentConfigurationVersion</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nUpdates the active environment configuration version for Extension 2.0.\n\n**Required scope:** extensions:definitions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#extensionenvironmentconfigurationversion\">ExtensionEnvironmentConfigurationVersion</a>| |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionEnvironmentConfigurationVersion](#extensionenvironmentconfigurationversion)|200|Success. Environment configuration updated.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.updateExtensionEnvironmentConfiguration(\n    { extensionName: \"...\", body: { version: \"1.2.3\" } },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"updateextensionmonitoringconfiguration\"></a>\n### updateExtensionMonitoringConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.updateExtensionMonitoringConfiguration(config): Promise&lt;<a href=\"#monitoringconfigurationresponse\" target=\"_blank\" rel=\"noopener noreferrer\">MonitoringConfigurationResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nUpdates a specified monitoring configuration for Extension 2.0.\n\n**Required scope:** extensions:configurations:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#monitoringconfigurationupdate\">MonitoringConfigurationUpdate</a>| |\n|config.configurationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the requested monitoring configuration. |\n|config.extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the requested Extension 2.0. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[MonitoringConfigurationResponse](#monitoringconfigurationresponse)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data =\n  await extensionsClient.updateExtensionMonitoringConfiguration(\n    {\n      extensionName: \"...\",\n      configurationId: \"...\",\n      body: {},\n    },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"uploadextension\"></a>\n### uploadExtension\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.uploadExtension(config): Promise&lt;<a href=\"#extensionuploadresponse\" target=\"_blank\" rel=\"noopener noreferrer\">ExtensionUploadResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nUploads a new Extension 2.0.\n\n**Required scope:** extensions:definitions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body<sup>*required</sup>|Blob| \n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtensionUploadResponse](#extensionuploadresponse)|201|Success. Extension 2.0 has been uploaded.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Failed. The input file is invalid. &#124; Upload isn't possible yet. Try again in a few seconds. &#124; Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.uploadExtension({\n  body: new Blob(),\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"validateextension\"></a>\n### validateExtension\n\n<div class=\"padding-bottom--md\">\n<strong>extensionsClient.validateExtension(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nVerifies a new Extension 2.0 for lack of any errors. Performs the same set of operations as upload but doesn&apos;t persist the changes.\n\n**Required scope:** extensions:definitions:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body<sup>*required</sup>|Blob| \n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Response doesn&apos;t have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { extensionsClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await extensionsClient.validateExtension({\n  body: new Blob(),\n});\n```\n\n</details>\n\n\n\n</div>\n\n## schemasClient\n\n```js\nimport { schemasClient } from '@dynatrace-sdk/client-extensions-v2';\n```\n\n\n<a name=\"getschemaversionfile\"></a>\n### getSchemaVersionFile\n\n<div class=\"padding-bottom--md\">\n<strong>schemasClient.getSchemaVersionFile(config): Promise&lt;JsonNode&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nRetrieves the schema file for a specified schema version of Extension 2.0.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.fileName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the schema file. |\n|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[JsonNode](#jsonnode)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { schemasClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await schemasClient.getSchemaVersionFile({\n  schemaVersion: \"...\",\n  fileName: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"listschemaversionfiles\"></a>\n### listSchemaVersionFiles\n\n<div class=\"padding-bottom--md\">\n<strong>schemasClient.listSchemaVersionFiles(config): Promise&lt;<a href=\"#schemafilelist\">SchemaFileList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all schema files for a specified schema version of Extension 2.0.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.acceptType<sup>*required</sup>|\"application/json; charset=utf-8\"| |\n|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success.|\n\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { schemasClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await schemasClient.listSchemaVersionFiles({\n  acceptType: \"application/json; charset=utf-8\",\n  schemaVersion: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n<div class=\"padding-bottom--md\">\n<strong>schemasClient.listSchemaVersionFiles(config): Promise&lt;Binary&gt;</strong>\n\n<div class=\"padding-left--md\">\n\n\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.acceptType<sup>*required</sup>|\"application/octet-stream\"| |\n|config.schemaVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success.|\n\n\n\n\n\n</div>\n\n\n<a name=\"listschemaversions\"></a>\n### listSchemaVersions\n\n<div class=\"padding-bottom--md\">\n<strong>schemasClient.listSchemaVersions(config): Promise&lt;<a href=\"#schemaversionlist\" target=\"_blank\" rel=\"noopener noreferrer\">SchemaVersionList</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all schema versions of Extension 2.0 available in the environment.\n\n**Required scope:** extensions:definitions:read\n\n\n\n</div>\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SchemaVersionList](#schemaversionlist)|200|Success.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorEnvelopeError|Client error. &#124; Server error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { schemasClient } from \"@dynatrace-sdk/client-extensions-v2\";\n\nconst data = await schemasClient.listSchemaVersions();\n```\n\n</details>\n\n\n\n</div>\n\n## Types\n\n### ActiveGateGroupInfo\n\nMetadata for each ActiveGate group.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|activeGates<sup>*required</sup>|Array&lt;<a href=\"#activegateinfo\">ActiveGateInfo</a>&gt;|ActiveGates in group. |\n|availableActiveGates<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of ActiveGates in group available for extension. |\n|groupName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ActiveGate group name. |\n\n### ActiveGateGroupInfoList\n\nActiveGate groups metadata for extensions.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|items<sup>*required</sup>|Array&lt;<a href=\"#activegategroupinfo\" target=\"_blank\" rel=\"noopener noreferrer\">ActiveGateGroupInfo</a>&gt;|Metadata for each ActiveGate group. |\n\n### ActiveGateInfo\n\nActiveGates in group.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|errors<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|List of errors if Extension can't be run on the ActiveGate |\n|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ActiveGate ID. |\n\n### AlertTemplate\n\n| Name | Type |\n| --- | --- |\n|templateJson|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### AssetInfo\n\nMetadata for an extension asset.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|assetSchemaDetails|<a href=\"#assetschemadetails\">AssetSchemaDetails</a>|Settings schema details for asset |\n|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User-friendly name of the asset. |\n|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ID of the asset. Identifies the asset in REST API and/or UI (where applicable). |\n|type|\"ALERT\" &#124; \"ALERT_TEMPLATE\" &#124; \"AWS_SERVICE\" &#124; \"CUSTOM_CARDS\" &#124; \"DASHBOARD\" &#124; \"DECLARATIVE_PROCESSES\" &#124; \"DOCUMENT_DASHBOARD\" &#124; \"DQL_LOG_METRIC\" &#124; \"DQL_LOG_PROCESSING_RULE\" &#124; \"GENERIC_RELATIONSHIP\" &#124; \"GENERIC_TYPE\" &#124; \"LIST_SCREEN_FILTERS\" &#124; \"LIST_SCREEN_INJECTIONS\" &#124; \"LIST_SCREEN_LAYOUT\" &#124; \"LOG_EVENT\" &#124; \"LOG_METRIC\" &#124; \"LOG_PROCESSING_RULE\" &#124; \"LQL_LOG_METRIC\" &#124; \"LQL_LOG_PROCESSING_RULE\" &#124; \"METRIC_METADATA\" &#124; \"METRIC_QUERY\" &#124; \"OPEN_PIPELINE\" &#124; \"PROCESS_GROUPING_RULES\" &#124; \"SCREEN_ACTIONS\" &#124; \"SCREEN_CHART_GROUPS\" &#124; \"SCREEN_DQL_TABLE\" &#124; \"SCREEN_ENTITIES_LISTS\" &#124; \"SCREEN_EVENTS_CARDS\" &#124; \"SCREEN_FILTERS\" &#124; \"SCREEN_HEALTH_CARDS\" &#124; \"SCREEN_INJECTIONS\" &#124; \"SCREEN_LAYOUT\" &#124; \"SCREEN_LOGS_CARDS\" &#124; \"SCREEN_MESSAGE_CARDS\" &#124; \"SCREEN_METRIC_TABLES\" &#124; \"SCREEN_PROBLEMS\" &#124; \"SCREEN_PROPERTIES\"|The type of the asset. |\n\n### AssetSchemaDetails\n\nSettings schema details for asset\n\n| Name | Type | Description |\n| --- | --- | --- |\n|key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Asset key |\n|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Asset schema id |\n|scope|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Asset configuration scope |\n\n### AuditLog\n\nThe audit log of your environment.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|auditLogs|Array&lt;<a href=\"#auditlogentry\" target=\"_blank\" rel=\"noopener noreferrer\">AuditLogEntry</a>&gt;|A list of audit log entries ordered by the creation timestamp. |\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p>  |\n|pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |\n|totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |\n\n### AuditLogEntry\n\nAn entry of the audit log.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|category<sup>*required</sup>|\"ACTIVEGATE_TOKEN\" &#124; \"BUILD_UNIT_V2\" &#124; \"CONFIG\" &#124; \"MANUAL_TAGGING_SERVICE\" &#124; \"TENANT_LIFECYCLE\" &#124; \"TOKEN\" &#124; \"WEB_UI\"|The category of the recorded operation. |\n|dt.settings.key|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The key of the affected object of a setting for entries of category <code>CONFIG</code>. |\n|dt.settings.object_id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the affected object of a setting for entries of category <code>CONFIG</code>. |\n|dt.settings.object_summary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The value summary for entries of category <code>CONFIG</code>. |\n|dt.settings.schema_id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema ID or config ID for entries of category <code>CONFIG</code>. |\n|dt.settings.scope_id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The persistence scope for entries of category <code>CONFIG</code>, e.g. an ME identifier. |\n|dt.settings.scope_name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the scope for entries of category <code>CONFIG</code>. |\n|entityId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The ID of an entity from the <strong>category</strong>.</p> <p>For example, it can be config ID for the <code>CONFIG</code> category or token ID for the <code>TOKEN</code> category.</p>  |\n|environmentId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the Dynatrace environment where the recorded operation occurred. |\n|eventType<sup>*required</sup>|\"CREATE\" &#124; \"DELETE\" &#124; \"LOGIN\" &#124; \"LOGOUT\" &#124; \"REORDER\" &#124; \"REVOKE\" &#124; \"TAG_ADD\" &#124; \"TAG_REMOVE\" &#124; \"TAG_UPDATE\" &#124; \"UPDATE\"|<p>The type of the recorded operation.</p> <ul> <li><code>LOGIN</code> -&gt; A user logged in</li> <li><code>LOGOUT</code> -&gt; A user logged out</li> <li><code>CREATE</code> -&gt; An object was created</li> <li><code>UPDATE</code> -&gt; An object was updated</li> <li><code>DELETE</code> -&gt; An object was deleted</li> <li><code>REVOKE</code> -&gt; An Active Gate token was revoked</li> <li><code>TAG_ADD</code> -&gt; A manual tag was added</li> <li><code>TAG_REMOVE</code> -&gt; A manual tag was removed</li> <li><code>TAG_UPDATE</code> -&gt; A manual tag was updated</li> <li><code>REMOTE_CONFIGURATION_MANAGEMENT</code> -&gt; A Remote Configuration Management related operation occurred</li> </ul>  |\n|logId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the log entry. |\n|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The logged message. |\n|patch|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|<p>The patch of the recorded operation as the JSON representation.</p> <p>The format is an enhanced RFC 6902. The patch also carries the previous value in the <strong>oldValue</strong> field.</p>  |\n|success<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The recorded operation is successful (<code>true</code>) or failed (<code>false</code>). |\n|timestamp<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the record creation, in UTC milliseconds. |\n|user<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the user who performed the recorded operation. |\n|userOrigin|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The origin and the IP address of the <strong>user</strong>. |\n|userType<sup>*required</sup>|\"PUBLIC_TOKEN_IDENTIFIER\" &#124; \"SERVICE_NAME\" &#124; \"TOKEN_HASH\" &#124; \"USER_NAME\"|<p>The type of the authentication of the <strong>user</strong>.</p> <ul> <li><code>USER_NAME</code> -&gt; User was logged in the UI</li> <li><code>TOKEN_HASH</code> -&gt;  URL Token or DevOps Token, the hash of the token is logged</li> <li><code>SERVICE_NAME</code> -&gt; No authenticated user at all, this action was performed by a system service automatically</li> <li><code>PUBLIC_TOKEN_IDENTIFIER</code> -&gt; API Token, the public token id is logged</li> </ul>  |\n\n### Author\n\nExtension author\n\n| Name | Type | Description |\n| --- | --- | --- |\n|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Author name |\n\n### ComplexConstraint\n\nA constraint on the values accepted for a complex settings property.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|checkAllProperties|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Defines if modification of any property triggers secret resubmission check. |\n|customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |\n|customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |\n|maximumPropertyCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of properties that can be set. |\n|minimumPropertyCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum number of properties that must be set. |\n|properties|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|A list of properties (defined by IDs) that are used to check the constraint. |\n|skipAsyncValidation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to skip validation on a change made from the UI. |\n|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time in seconds the custom validator is allowed to run. |\n|type<sup>*required</sup>|\"CUSTOM_VALIDATOR_REF\" &#124; \"GREATER_THAN\" &#124; \"GREATER_THAN_OR_EQUAL\" &#124; \"LESS_THAN\" &#124; \"LESS_THAN_OR_EQUAL\" &#124; \"PROPERTY_COUNT_RANGE\" &#124; \"SECRET_RESUBMISSION\" &#124; \"UNKNOWN\"|The type of the constraint. |\n\n### Constraint\n\nA constraint on the values accepted for a settings property.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |\n|customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |\n|disallowDangerousRegex|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to disallow usage of dangerous regexes |\n|maxLength|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum allowed length of string values. |\n|maximum|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum allowed value. |\n|minLength|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum required length of string values. |\n|minimum|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The minimum allowed value. |\n|pattern|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The regular expression pattern for valid string values. |\n|skipAsyncValidation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to skip validation on a change made from the UI. |\n|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time in seconds the custom validator is allowed to run. |\n|type<sup>*required</sup>|\"CUSTOM_VALIDATOR_REF\" &#124; \"UNKNOWN\" &#124; \"LENGTH\" &#124; \"NOT_BLANK\" &#124; \"NOT_EMPTY\" &#124; \"NO_WHITESPACE\" &#124; \"PATTERN\" &#124; \"RANGE\" &#124; \"REGEX\" &#124; \"TRIMMED\" &#124; \"UNIQUE\"|The type of the constraint. |\n|uniqueProperties|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|A list of properties for which the combination of values must be unique. |\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\" &#124; \"PATH\" &#124; \"PAYLOAD_BODY\" &#124; \"QUERY\"| \n|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### DatasourceDefinition\n\nConfiguration of a datasource for a property.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|filterProperties<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The properties to filter the datasource options on. |\n|fullContext<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether this datasource expects full setting payload as the context. |\n|identifier<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The identifier of a custom data source of the property's value. |\n|resetValue|\"ALWAYS\" &#124; \"INVALID_ONLY\" &#124; \"NEVER\"|When to reset datasource value in the UI on filter change. |\n|useApiSearch<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the datasource should use the api to filter the results instead of client-side filtering. |\n|validate<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether to validate input to only allow values returned by the datasource. |\n\n### DeletionConstraint\n\nA constraint on the values that are going to be deleted.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|customMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A custom message for invalid values. |\n|customValidatorId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of a custom validator. |\n|schemaIds|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;| |\n|timeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum time in seconds the custom validator is allowed to run. |\n|type<sup>*required</sup>|\"CUSTOM_VALIDATOR_REF\" &#124; \"UNKNOWN\" &#124; \"REFERENTIAL_INTEGRITY\"|The type of the deletion constraint. |\n\n### EnumType\n\nDefinition of an enum property.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the property. |\n|displayName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the property. |\n|documentation<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An extended description and/or links to documentation. |\n|enumClass|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An existing Java enum class that holds the allowed values of the enum. |\n|items<sup>*required</sup>|Array&lt;<a href=\"#enumvalue\">EnumValue</a>&gt;|A list of allowed values of the enum. |\n|type<sup>*required</sup>|\"enum\"|The type of the property. |\n\n### EnumValue\n\nAn allowed value for an enum property.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short description of the value. |\n|displayName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The display name of the value. |\n|enumInstance|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the value in an existing Java enum class. |\n|icon|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The icon of the value. |\n|value<sup>*required</sup>|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)|The allowed value of the enum. |\n\n### EnvironmentConfiguration\n\nList of assets imported with the active extension environment configuration.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|assets<sup>*required</sup>|Array&lt;<a href=\"#assetinfo\" target=\"_blank\" rel=\"noopener noreferrer\">AssetInfo</a>&gt;|The list of the imported assets. |\n|errors<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|List of errors during asset import |\n|status<sup>*required</sup>|\"PENDING\" &#124; \"UP_TO_DATE\"|The status of the assets list. |\n|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Version of the active extension environment configuration. <br/>Pattern: <code>^(0&#124;\\[1-9]\\\\d\\*)(\\\\.(0&#124;\\[1-9]\\\\d\\*))?(\\\\.(0&#124;\\[1-9]\\\\d\\*))?</code>|\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|details|<a href=\"#errordetails\">ErrorDetails</a>|The error details. |\n|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message. |\n\n### ErrorDetails\n\nThe error details.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|constraintViolations|Array&lt;<a href=\"#constraintviolation\" target=\"_blank\" rel=\"noopener noreferrer\">ConstraintViolation</a>&gt;|A list of constraint violations. |\n\n### ErrorEnvelope\n\n| Name | Type |\n| --- | --- |\n|error|<a href=\"#error\">Error</a>|\n\n### ExecuteActions\n\n| Name | Type | Description |\n| --- | --- | --- |\n|actions|<a href=\"#executeactionsactions\" target=\"_blank\" rel=\"noopener noreferrer\">ExecuteActionsActions</a>|Data Source defined action objects |\n\n### ExecuteActionsActions\n\nData Source defined action objects\n\n**type**: Record&lt;string, JsonNode&gt;\n\n### ExecuteActionsResponse\n\n| Name | Type | Description |\n| --- | --- | --- |\n|~~activeGateId~~<sup>**DEPRECATED**</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Active Gate id for actions execution |\n|activeGateIds|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Active Gate ids for actions execution |\n|~~activeGateName~~<sup>**DEPRECATED**</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Active Gate name for actions execution |\n\n### Extension\n\n| Name | Type | Description |\n| --- | --- | --- |\n|author<sup>*required</sup>|<a href=\"#author\">Author</a>|Extension author |\n|dataSources<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Data sources that extension uses to gather data |\n|extensionName<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Extension name |\n|featureSets<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Available feature sets |\n|featureSetsDetails<sup>*required</sup>|<a href=\"#extensionfeaturesetsdetails\" target=\"_blank\" rel=\"noopener noreferrer\">ExtensionFeatureSetsDetails</a>|Details of fea","readmeFilename":"README.md"}