Extensions 2.0

• Reference

Documentation of Extensions 2.0 API.

@dynatrace-sdk/client-extensions-v2

v3.1.0

Latest (V3)

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

discoveryClient

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

getJmxProcess

discoveryClient.getJmxProcess(config): Promise<JavaProcessDetails>

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.

Code example

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

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

listJmxProcesses

discoveryClient.listJmxProcesses(config): Promise<JavaProcessContainerList>

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

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'

Returns

Return type	Status code	Description
JavaProcessContainerList	200	Success.

Throws

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

Code example

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

const data = await discoveryClient.listJmxProcesses();

extensionsClient

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

activateExtensionEnvironmentConfiguration

extensionsClient.activateExtensionEnvironmentConfiguration(config): Promise<ExtensionEnvironmentConfigurationVersion>

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.

Code example

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

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

createExtensionMonitoringConfiguration

extensionsClient.createExtensionMonitoringConfiguration(config): Promise<MonitoringConfigurationResponse>

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.

Code example

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

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

deleteExtensionEnvironmentConfiguration

extensionsClient.deleteExtensionEnvironmentConfiguration(config): Promise<void>

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.

Code example

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

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

deleteExtensionMonitoringConfiguration

extensionsClient.deleteExtensionMonitoringConfiguration(config): Promise<void>

Deletes a specified monitoring configuration for Extension 2.0.

Required scope: extensions:configurations:write

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.

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.

Code example

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

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

deleteExtensionVersion

extensionsClient.deleteExtensionVersion(config): Promise<Extension>

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.

Code example

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

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

executeExtensionMonitoringConfigurationActions

extensionsClient.executeExtensionMonitoringConfigurationActions(config): Promise<ExecuteActionsResponse>

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.

Code example

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

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

getActiveExtensionEnvironmentConfiguration

extensionsClient.getActiveExtensionEnvironmentConfiguration(config): Promise<EnvironmentConfiguration>

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.

Code example

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

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

getActiveGateGroups

extensionsClient.getActiveGateGroups(config): Promise<ActiveGateGroupInfoList>

Lists all ActiveGate groups available 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.extensionVersion*required	string	The version of the requested Extension 2.0

Returns

Return type	Status code	Description
ActiveGateGroupInfoList	200	Success.

Throws

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

Code example

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

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

getAlertTemplate

extensionsClient.getAlertTemplate(config): Promise<AlertTemplate>

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.

Code example

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

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

getExtensionConfigurationSchema

extensionsClient.getExtensionConfigurationSchema(config): Promise<SchemaDefinitionRestDto>

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

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
SchemaDefinitionRestDto	200	Success.

Throws

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

Code example

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

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

getExtensionDetails

extensionsClient.getExtensionDetails(config): Promise<Extension>

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.

Code example

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

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

extensionsClient.getExtensionDetails(config): Promise<Binary>

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

extensionsClient.getExtensionMonitoringConfigurationAudit(config): Promise<AuditLog>

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.

Code example

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

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

getExtensionMonitoringConfigurationDetails

extensionsClient.getExtensionMonitoringConfigurationDetails(config): Promise<ExtensionMonitoringConfiguration>

Retrieves details of a specified monitoring configuration for 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.

Returns

Return type	Status code	Description
ExtensionMonitoringConfiguration	200	Success.

Throws

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

Code example

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

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

getExtensionMonitoringConfigurationStatus

extensionsClient.getExtensionMonitoringConfigurationStatus(config): Promise<ExtensionStatus>

Retrieves the most recent execution status of a specified monitoring configuration for 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.

Returns

Return type	Status code	Description
ExtensionStatus	200	Success.

Throws

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

Code example

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

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

getExtensionMonitoringConfigurationStatuses

extensionsClient.getExtensionMonitoringConfigurationStatuses(config): Promise<ExtensionStatusWithIdList>

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.

Code example

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

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

installExtension

extensionsClient.installExtension(config): Promise<RegisteredExtensionResult>

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.

Code example

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

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

listExtensionMonitoringConfigurations

extensionsClient.listExtensionMonitoringConfigurations(config): Promise<ExtensionMonitoringConfigurationList>

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.

Code example

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

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

listExtensionVersions

extensionsClient.listExtensionVersions(config): Promise<ExtensionList>

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.

Code example

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

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

listExtensions

extensionsClient.listExtensions(config): Promise<ExtensionInfoList>

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.

Code example

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

const data = await extensionsClient.listExtensions();

updateExtensionEnvironmentConfiguration

extensionsClient.updateExtensionEnvironmentConfiguration(config): Promise<ExtensionEnvironmentConfigurationVersion>

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.

Code example

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

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

updateExtensionMonitoringConfiguration

extensionsClient.updateExtensionMonitoringConfiguration(config): Promise<MonitoringConfigurationResponse>

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.

Code example

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

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

uploadExtension

extensionsClient.uploadExtension(config): Promise<ExtensionUploadResponse>

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.

Code example

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

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

validateExtension

extensionsClient.validateExtension(config): Promise<void>

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.

Code example

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

schemasClient.getSchemaVersionFile(config): Promise<JsonNode>

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.

Code example

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

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

listSchemaVersionFiles

schemasClient.listSchemaVersionFiles(config): Promise<SchemaFileList>

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.

Code example

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

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

schemasClient.listSchemaVersionFiles(config): Promise<Binary>

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

schemasClient.listSchemaVersions(config): Promise<SchemaVersionList>

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.

Code example

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
activeGateIdDEPRECATED	string	Active Gate id for actions execution
activeGateIds	Array<string>	Active Gate ids for actions execution
activeGateNameDEPRECATED	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 feature sets
fileHash*required	string	SHA-256 hash of uploaded Extension file
minDynatraceVersion*required	string	Minimal Dynatrace version that works with the extension
minEECVersion*required	string	Minimal Extension Execution Controller version that works with the extension
variables*required	Array<string>	Custom variables used in extension configuration
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionEnvironmentConfigurationVersion

Name	Type	Description
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionFeatureSetsDetails

Details of feature sets

type: Record<string, FeatureSetDetails>

ExtensionInfo

A list of extensions with additional metadata.

Name	Type	Description
activeVersion	null | string	Active version in the environment (null if none is active) Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?
extensionName*required	string	Extension name
keywords*required	Array<string>	Extension keywords for the highest version
markedForDeletion	null | boolean	Indicates if the extension is marked for deletion
version*required	string	Highest installed version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionInfoList

A list of extensions with additional metadata.

Name	Type	Description
items*required	Array<ExtensionInfo>	A list of extensions with additional metadata.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the page-key query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ExtensionList

A list of extensions.

Name	Type	Description
items*required	Array<MinimalExtension>	A list of extensions.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the page-key query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number	The total number of entries in the result.

ExtensionMonitoringConfiguration

A list of extension monitoring configurations.

Name	Type	Description
modificationInfo*required	ModificationInfo	Audit information about the creation and modification of this resource
objectId*required	string	Configuration id
scope*required	string	Configuration scope
value*required	ExtensionMonitoringConfigurationValue	Configuration

ExtensionMonitoringConfigurationList

Name	Type	Description
items*required	Array<ExtensionMonitoringConfiguration>	A list of extension monitoring configurations.
nextPageKey	string	The cursor for the next page of results. Has the value of null on the last page. Use it in the page-key query parameter to obtain subsequent pages of the result.
pageSize	number	The number of entries per page.
totalCount*required	number

ExtensionStatus

Name	Type	Description
status*required	"UNKNOWN" | "PENDING" | "ERROR" | "OK" | "WARNING"	Latest status of given configuration.
timestamp	string	Timestamp of the latest status of given configuration.

ExtensionStatusWithId

Name	Type	Description
configurationId*required	string	Unique ID of the configuration.
status*required	"UNKNOWN" | "PENDING" | "ERROR" | "OK" | "WARNING"	Latest status of given configuration.
timestamp	string	Timestamp of the latest status of given configuration.

ExtensionStatusWithIdList

Name	Type
items*required	Array<ExtensionStatusWithId>

ExtensionUploadResponse

Name	Type	Description
assetsInfo*required	Array<UploadResponseAssetInfo>	Information about extension assets included
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	ExtensionUploadResponseFeatureSetsDetails	Details of feature sets
fileHash*required	string	SHA-256 hash of uploaded Extension file
minDynatraceVersion*required	string	Minimal Dynatrace version that works with the extension
minEECVersion*required	string	Minimal Extension Execution Controller version that works with the extension
variables*required	Array<string>	Custom variables used in extension configuration
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ExtensionUploadResponseFeatureSetsDetails

Details of feature sets

type: Record<string, FeatureSetDetails>

FeatureSetDetails

Additional information about a Feature Set

Name	Type	Description
description	string	Optional description for the feature set
displayName	string	Optional display name of the feature set
isRecommended*required	boolean	Marks the feature set as recommended (selected by default during activation)
metrics	Array<Metric>	Feature set metrics

InsertPosition

The position where the button should be shown relative to a property in the UI

Name	Type	Description
after*required	string	The path of a property after which the button should be shown in the UI

Item

An item of a collection property.

Name	Type	Description
constraints	Array<Constraint>	A list of constraints limiting the values to be accepted.
datasource	DatasourceDefinition	Configuration of a datasource for a property.
description	string	A short description of the item.
displayName	string	The display name of the item.
documentation	string	An extended description and/or links to documentation.
metadata	ItemMetadata	Metadata of the items.
referencedType	string	The type referenced by the item's value.
subType	string	The subtype of the item's value.
type*required	string | RefPointer	The type of the item's value.
uiCustomization	UiCustomization	Customization for UI elements

ItemMetadata

Metadata of the items.

type: Record<string, string>

JavaProcessContainer

Name	Type
agentVersion	string
id	string
name	string
properties	JavaProcessContainerProperties

JavaProcessContainerList

Name	Type
items*required	Array<JavaProcessContainer>

JavaProcessContainerProperties

type: Record<string, string[]>

Metric

Metric gathered by an extension

Name	Type	Description
key	string	Metric key
metadata	MetricMetadata	Metric metadata

MetricMetadata

Metric metadata

Name	Type	Description
description	string	A short description of the metric
displayName	string	The name of the metric in the user interface
unit	string	The unit of the metric

MinimalExtension

A list of extensions.

Name	Type	Description
extensionName*required	string	Extension name
version*required	string	Extension version Pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))?(\.(0|[1-9]\d*))?

ModificationInfo

Audit information about the creation and modification of this resource

Name	Type	Description
createdBy	string	User who created the configuration
createdTime	string	Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
lastModifiedBy	string	User who last modified the configuration
lastModifiedTime	string	Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

MonitoringConfiguration

Name	Type	Description
scope*required	string	The scope this monitoring configuration will be defined for
value	JsonNode	The monitoring configuration

MonitoringConfigurationResponse

Name	Type	Description
code*required	number	The HTTP Status code
objectId*required	string	The identifier of the new configuration

MonitoringConfigurationUpdate

Name	Type	Description
value	JsonNode	The monitoring configuration

Precondition

A precondition for visibility of a property.

Name	Type	Description
expectedValue	any	The expected value of the property. Only applicable to properties of the EQUALS type.
expectedValues	Array<any>	A list of valid values of the property. Only applicable to properties of the IN type.
pattern	string	The Regular expression which is matched against the property. Only applicable to properties of the REGEX_MATCH type.
precondition	Precondition	A precondition for visibility of a property.
preconditions	Array<Precondition>	A list of child preconditions to be evaluated. Only applicable to properties of the AND and OR types.
property	string	The property to be evaluated.
type*required	"AND" | "EQUALS" | "IN" | "NOT" | "NULL" | "OR" | "REGEX_MATCH"	The type of the precondition.

PropertyDefinition

Configuration of a property in a settings schema.

Name	Type	Description
constraints	Array<Constraint>	A list of constraints limiting the values to be accepted.
datasource	DatasourceDefinition	Configuration of a datasource for a property.
default	any	The default value to be used when no value is provided. If a non-singleton has the value of null, it means an empty collection.
description	string	A short description of the property.
displayName	string	The display name of the property.
documentation	string	An extended description and/or links to documentation.
forceSecretResubmission	boolean	Defines if value is allowed to be modified when secret properties are not
items	Item	An item of a collection property.
maxObjects*required	number	The maximum number of objects in a collection property. Has the value of 1 for singletons.
metadata	PropertyDefinitionMetadata	Metadata of the property.
migrationPattern	string	Pattern with references to properties to create a new value.
minObjects	number	The minimum number of objects in a collection property.
modificationPolicy	"ALWAYS" | "NEVER" | "DEFAULT"	Modification policy of the property.
nullable*required	boolean	The value can (true) or can't (false) be null.
precondition	Precondition	A precondition for visibility of a property.
referencedType	string	The type referenced by the property value
subType	string	The subtype of the property's value.
type*required	string | RefPointer	The type of the property's value.
uiCustomization	UiCustomization	Customization for UI elements

PropertyDefinitionMetadata

Metadata of the property.

type: Record<string, string>

RefPointer

Object with a pointer to a JSON object

Name	Type	Description
$ref*required	string	Pointer to a JSON object this object should be logically replaced with.

RegisteredExtensionResult

Name	Type	Description
extensionName	string	FQN of the extension registered in the tenant.
extensionVersion	string	Version number of the extension.

SchemaConstraintRestDto

Name	Type	Description
byteLimit	number	The maximum allowed size in bytes for the sum over all persisted values for the schema
customMessage	string	A custom message for invalid values.
customValidatorId	string	The ID of a custom validator.
flattenCollections	boolean	Whether to flatten collection properties when checking for uniqueness, so only disjoint collections are considered unique
skipAsyncValidation	boolean	Whether to skip validation on a change made from the UI.
type*required	"CUSTOM_VALIDATOR_REF" | "UNKNOWN" | "UNIQUE" | "BYTE_SIZE_LIMIT" | "MULTI_SCOPE_CUSTOM_VALIDATOR_REF" | "MULTI_SCOPE_UNIQUE"	The type of the schema constraint.
uniqueProperties	Array<string>	The list of properties for which the combination of values needs to be unique

SchemaDefinitionRestDto

Name	Type	Description
allowedScopes*required	Array<string>	A list of scopes where the schema can be used.
constraints	Array<ComplexConstraint>	A list of constrains limiting the values to be accepted by the schema.
deletionConstraints	Array<DeletionConstraint>	Constraints limiting the values to be deleted.
description*required	string	A short description of the schema.
displayName*required	string	The display name of the schema.
documentation	string	An extended description of the schema and/or links to documentation.
dynatrace*required	string	The version of the data format.
enums*required	SchemaDefinitionRestDtoEnums	A list of definitions of enum properties.
keyProperty	string	Name of the key property in this schema.
maturity	"EARLY_ADOPTER" | "GENERAL_AVAILABILITY" | "PREVIEW"	The maturity of the schema. Possible values: PREVIEW: Preview features are not generally available, but might be available in specific environments as part of early-access programs. These are the most likely to change in incompatible ways. EARLY_ADOPTER: Features marked "early adopter" are available in all environments, but are not mature enough to warrant the "general availability" designation. We don't expect incompatible changes for these, but please be aware, that these are not fully stable yet and incompatible changes may be necessary in rare cases. GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner. In any case, automations should make use of the schemaVersion field when writing settings objects.
maxObjects*required	number	The maximum amount of objects per scope. Only applicable when multiObject is set to true.
metadata	SchemaDefinitionRestDtoMetadata	Metadata of the setting.
multiObject*required	boolean	Multiple (true) objects per scope are permitted or a single (false) object per scope is permitted.
ordered	boolean	If true the order of objects has semantic significance. Only applicable when multiObject is set to true.
properties*required	SchemaDefinitionRestDtoProperties	A list of schema's properties.
schemaConstraints	Array<SchemaConstraintRestDto>	Constraints limiting the values as a whole to be accepted in this configuration element.
schemaGroups	Array<string>	Names of the groups, which the schema belongs to.
schemaId*required	string	The ID of the schema.
tableColumns	SchemaDefinitionRestDtoTableColumns	Table column definitions for use in the ui.
types*required	SchemaDefinitionRestDtoTypes	A list of definitions of types. A type is a complex property that contains its own set of subproperties.
uiCustomization	UiCustomization	Customization for UI elements
version*required	string	The version of the schema.

SchemaDefinitionRestDtoEnums

A list of definitions of enum properties.

type: Record<string, EnumType>

SchemaDefinitionRestDtoMetadata

Metadata of the setting.

type: Record<string, string>

SchemaDefinitionRestDtoProperties

A list of schema's properties.

type: Record<string, PropertyDefinition>

SchemaDefinitionRestDtoTableColumns

Table column definitions for use in the ui.

type: Record<string, TableColumn>

SchemaDefinitionRestDtoTypes

A list of definitions of types.

A type is a complex property that contains its own set of subproperties.

type: Record<string, SchemaType>

SchemaFileList

A list of schema files.

Name	Type	Description
items*required	Array<string>	A list of schema files.

SchemaType

A list of definitions of types.

A type is a complex property that contains its own set of subproperties.

Name	Type	Description
constraints	Array<ComplexConstraint>	A list of constraints limiting the values to be accepted.
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.
properties*required	SchemaTypeProperties	Definition of properties that can be persisted.
searchPattern	string	The pattern for the summary search(for example, "Alert after X minutes.") of the configuration in the UI.
summaryPattern*required	string	The pattern for the summary (for example, "Alert after X minutes.") of the configuration in the UI.
type*required	"object"	Type of the reference type.
version*required	string	The version of the type.
versionInfo	string	A short description of the version.

SchemaTypeProperties

Definition of properties that can be persisted.

type: Record<string, PropertyDefinition>

SchemaVersionList

A list of available schema versions.

Name	Type	Description
items*required	Array<string>	A list of schema versions.

TableColumn

The definition of a table column to be used in the ui.

Name	Type	Description
pattern*required	string	Pattern with references to properties to create a single value for the column.

UiButtonCustomization

UI customization for defining a button that calls a function when pressed

Name	Type	Description
description	string	The description to be shown in a tooltip when hovering over the button
displayName*required	string	The label of the button
identifier*required	string	The identifier of the function to be called when the button is pressed
insert*required	string | InsertPosition	The position where the button should be shown in the UI

UiCallbackCustomization

UI customization options for defining custom callbacks

Name	Type	Description
buttons	Array<UiButtonCustomization>	UI customization for defining buttons that call functions when pressed

UiCustomization

Customization for UI elements

Name	Type	Description
callback	UiCallbackCustomization	UI customization options for defining custom callbacks
expandable	UiExpandableCustomization	UI customization for expandable section
table	UiTableCustomization	Customization for UI tables
tabs	UiTabsCustomization	UI customization for tabs

UiEmptyStateCustomization

UI customization for empty state in a table

Name	Type	Description
text	string	The text to be shown in the empty state

UiExpandableCustomization

UI customization for expandable section

Name	Type	Description
displayName	string	The display name
expanded	boolean	Defines if the item should be expanded by default
sections	Array<UiExpandableSectionCustomization>	A list of sections

UiExpandableSectionCustomization

Expandable section customization for UI

Name	Type	Description
description	string	The description
displayName*required	string	The display name
expanded	boolean	Defines if the section should be expanded by default
properties*required	Array<string>	A list of properties

UiTabGroupCustomization

Tab group customization for UI

Name	Type	Description
description	string	The description
displayName*required	string	The display name
properties*required	Array<string>	A list of properties

UiTableColumnCustomization

Customization for UI table columns

Name	Type	Description
builtinColumnRef	string	The ui specific builtin column-implementation for this column.
columnRef	string	The referenced column from the 'tableColumns' property of the schema for this column.
displayName	string	The display name for this column.
id	string	The id for this column used for filtering. Required for conflicting or pathed columns - otherwise the ref is used.
items	Array<UiTableColumnItemCustomization>	The possible items of this column.
propertyRef	string	The referenced property for this column.
type	string	The ui specific type for this column.
width	string	The width this column should take up on the table.

UiTableColumnItemCustomization

Customization for UI table column items

Name	Type	Description
displayName	string	The display name of this item.
icon	string	The icon of this item.
value*required	string	The value of this item.

UiTableCustomization

Customization for UI tables

Name	Type	Description
columns	Array<UiTableColumnCustomization>	A list of columns for the UI table
emptyState	UiEmptyStateCustomization	UI customization for empty state in a table

UiTabsCustomization

UI customization for tabs

Name	Type	Description
groups	Array<UiTabGroupCustomization>	A list of groups

UploadResponseAssetInfo

Information about extension assets included

Name	Type
assetType	string
count	number

Enums

AssetInfoType

⚠️ Deprecated Use literal values.

The type of the asset.

Enum keys

Alert | AlertTemplate | AwsService | CustomCards | Dashboard | DeclarativeProcesses | DocumentDashboard | DqlLogMetric | DqlLogProcessingRule | GenericRelationship | GenericType | ListScreenFilters | ListScreenInjections | ListScreenLayout | LogEvent | LogMetric | LogProcessingRule | LqlLogMetric | LqlLogProcessingRule | MetricMetadata | MetricQuery | OpenPipeline | ProcessGroupingRules | ScreenActions | ScreenChartGroups | ScreenDqlTable | ScreenEntitiesLists | ScreenEventsCards | ScreenFilters | ScreenHealthCards | ScreenInjections | ScreenLayout | ScreenLogsCards | ScreenMessageCards | ScreenMetricTables | ScreenProblems | ScreenProperties

AuditLogEntryCategory

⚠️ Deprecated Use literal values.

The category of the recorded operation.

Enum keys

ActivegateToken | BuildUnitV2 | Config | ManualTaggingService | TenantLifecycle | Token | WebUi

AuditLogEntryEventType

⚠️ Deprecated Use literal values.

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

Enum keys

Create | Delete | Login | Logout | Reorder | Revoke | TagAdd | TagRemove | TagUpdate | Update

AuditLogEntryUserType

⚠️ Deprecated Use literal values.

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

Enum keys

PublicTokenIdentifier | ServiceName | TokenHash | UserName

ComplexConstraintType

⚠️ Deprecated Use literal values.

The type of the constraint.

Enum keys

CustomValidatorRef | GreaterThan | GreaterThanOrEqual | LessThan | LessThanOrEqual | PropertyCountRange | SecretResubmission | Unknown

ConstraintType

⚠️ Deprecated Use literal values.

The type of the constraint.

Enum keys

CustomValidatorRef | Length | NoWhitespace | NotBlank | NotEmpty | Pattern | Range | Regex | Trimmed | Unique | Unknown

ConstraintViolationParameterLocation

⚠️ Deprecated Use literal values.

Enum keys

Header | Path | PayloadBody | Query

DatasourceDefinitionResetValue

⚠️ Deprecated Use literal values.

When to reset datasource value in the UI on filter change.

Enum keys

Always | InvalidOnly | Never

DeletionConstraintType

⚠️ Deprecated Use literal values.

The type of the deletion constraint.

Enum keys

CustomValidatorRef | ReferentialIntegrity | Unknown

EnumTypeType

⚠️ Deprecated Use literal values.

The type of the property.

Enum keys

Enum

EnvironmentConfigurationStatus

⚠️ Deprecated Use literal values.

The status of the assets list.

Enum keys

Pending | UpToDate

ExtensionStatusStatus

⚠️ Deprecated Use literal values.

Latest status of given configuration.

Enum keys

Error | Ok | Pending | Unknown | Warning

ExtensionStatusWithIdStatus

⚠️ Deprecated Use literal values.

Latest status of given configuration.

Enum keys

Error | Ok | Pending | Unknown | Warning

PreconditionType

⚠️ Deprecated Use literal values.

The type of the precondition.

Enum keys

And | Equals | In | Not | Null | Or | RegexMatch

PropertyDefinitionModificationPolicy

⚠️ Deprecated Use literal values.

Modification policy of the property.

Enum keys

Always | Default | Never

SchemaConstraintRestDtoType

⚠️ Deprecated Use literal values.

The type of the schema constraint.

Enum keys

ByteSizeLimit | CustomValidatorRef | MultiScopeCustomValidatorRef | MultiScopeUnique | Unique | Unknown

SchemaDefinitionRestDtoMaturity

⚠️ Deprecated Use literal values.

The maturity of the schema. Possible values:

• PREVIEW: Preview features are not generally available, but might be available in specific environments as part of early-access programs. These are the most likely to change in incompatible ways.
• EARLY_ADOPTER: Features marked "early adopter" are available in all environments, but are not mature enough to warrant the "general availability" designation. We don't expect incompatible changes for these, but please be aware, that these are not fully stable yet and incompatible changes may be necessary in rare cases.
• GENERAL_AVAILABILITY: Features marked "general availability" are the most stable. While the schemas will still evolve over time, care will be taken to only do so in a backward-compatible manner.

In any case, automations should make use of the schemaVersion field when writing settings objects.

Enum keys

EarlyAdopter | GeneralAvailability | Preview

SchemaTypeType

⚠️ Deprecated Use literal values.

Type of the reference type.

Enum keys

Object