{"_id":"@dynatrace-sdk/client-synthetic","_rev":"4-9afb29beea721ef089d3ccc77e7eb3f9","name":"@dynatrace-sdk/client-synthetic","dist-tags":{"latest":"4.0.0"},"versions":{"1.0.0":{"name":"@dynatrace-sdk/client-synthetic","version":"1.0.0","license":"Apache-2.0","_id":"@dynatrace-sdk/client-synthetic@1.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":"1e0e7853521267255b478fafea3ad93aad774ab7","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-synthetic/-/client-synthetic-1.0.0.tgz","fileCount":8,"integrity":"sha512-2KYrAqLEyxmLkXM8xN6BRkjWYcgPwX7yL6ppE+VJPvIAFbcct6sOncsi+n+hHzOZT99A+prhNTRfEE2fMByJag==","signatures":[{"sig":"MEQCICjWykEuy1GYLwVGn93rM4qu4xVh6YZkkiY39StgBC5ZAiA8FsvMD8GORh/LqaMG6zxcBsanhUxC0ZJSJZLej5DlBA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":271317},"main":"./cjs/index.js","_from":"file:dynatrace-sdk-client-synthetic-1.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-synthetic-1.0.0-w640Uz/dynatrace-sdk-client-synthetic-1.0.0.tgz","_integrity":"sha512-2KYrAqLEyxmLkXM8xN6BRkjWYcgPwX7yL6ppE+VJPvIAFbcct6sOncsi+n+hHzOZT99A+prhNTRfEE2fMByJag==","_npmVersion":"11.6.2","description":"[![npm](https://img.shields.io/badge/npm-v1.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-synthetic/v/1.0.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)","directories":{},"_nodeVersion":"24.13.0","dependencies":{"@dynatrace-sdk/http-client":"^1.5.1","@dynatrace-sdk/shared-errors":"^1.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/client-synthetic_1.0.0_1778755345636_0.3265751151501428","host":"s3://npm-registry-packages-npm-production"}},"2.0.0":{"name":"@dynatrace-sdk/client-synthetic","version":"2.0.0","license":"Apache-2.0","_id":"@dynatrace-sdk/client-synthetic@2.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":"907673735cbf5fd3c95b1bec1074381d67b8a0eb","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-synthetic/-/client-synthetic-2.0.0.tgz","fileCount":8,"integrity":"sha512-OZQRR8+dyO8YOB3er4VvlrMjsPiZgtIZxV+HBSFsHqiJ9OTYdy9Qj4Vq2wO/DQR2h68p111d5G81ZpVVDvvNNA==","signatures":[{"sig":"MEQCIExHwnyCRyx1OvqkvspxHUzY+Uq8B4aA7aLI4Uc5CX2tAiAYb1BbXEGGoYZACTRR6gNZBoS8N64m5aO+DywrNX43rA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":549093},"main":"./cjs/index.js","_from":"file:dynatrace-sdk-client-synthetic-2.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-synthetic-2.0.0-nxZSZq/dynatrace-sdk-client-synthetic-2.0.0.tgz","_integrity":"sha512-OZQRR8+dyO8YOB3er4VvlrMjsPiZgtIZxV+HBSFsHqiJ9OTYdy9Qj4Vq2wO/DQR2h68p111d5G81ZpVVDvvNNA==","_npmVersion":"11.6.2","description":"[![npm](https://img.shields.io/badge/npm-v2.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-synthetic/v/2.0.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)","directories":{},"_nodeVersion":"24.13.0","dependencies":{"@dynatrace-sdk/http-client":"^1.5.1","@dynatrace-sdk/shared-errors":"^1.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/client-synthetic_2.0.0_1784277662171_0.8805911882947164","host":"s3://npm-registry-packages-npm-production"}},"3.0.0":{"name":"@dynatrace-sdk/client-synthetic","version":"3.0.0","license":"Apache-2.0","_id":"@dynatrace-sdk/client-synthetic@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":"e62a2580bbdf562bfa7b6358924f4f6b626fb93a","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-synthetic/-/client-synthetic-3.0.0.tgz","fileCount":8,"integrity":"sha512-ennAhDoZwaDobbebV4C8Nu8jjFntvbj1LTpLRT+FUkP0Jz57HwKFGuYYYh+HXxjE486TweKWFb1SZ8B4IOzgkw==","signatures":[{"sig":"MEUCIAmVHmbzN8wDYNYAspWcB8B14rnVUPlG+6qj+f6svHG9AiEA/ToGyJqQrdRi8pwIHv0AAvRiC9iOGuNu4IrW+F49Mzo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":553660},"main":"./cjs/index.js","_from":"file:dynatrace-sdk-client-synthetic-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-synthetic-3.0.0-OLywH2/dynatrace-sdk-client-synthetic-3.0.0.tgz","_integrity":"sha512-ennAhDoZwaDobbebV4C8Nu8jjFntvbj1LTpLRT+FUkP0Jz57HwKFGuYYYh+HXxjE486TweKWFb1SZ8B4IOzgkw==","_npmVersion":"11.16.0","description":"[![npm](https://img.shields.io/badge/npm-v3.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-synthetic/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":"24.18.0","dependencies":{"@dynatrace-sdk/http-client":"^1.5.1","@dynatrace-sdk/shared-errors":"^1.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/client-synthetic_3.0.0_1786539040722_0.7771270396128247","host":"s3://npm-registry-packages-npm-production"}},"4.0.0":{"_id":"@dynatrace-sdk/client-synthetic@4.0.0","dist":{"shasum":"dcf1cbeb81893f25e6936174d166d1f6c2a5c6be","tarball":"https://registry.npmjs.org/@dynatrace-sdk/client-synthetic/-/client-synthetic-4.0.0.tgz","fileCount":9,"integrity":"sha512-fipSb31PT5GHx5BqQT60Ej5HahCLoROJCZO0uVXHFRehnMa3XJpwDDfZScJqJbtDXDL/ovjqE0f+lzAbequCXQ==","signatures":[{"sig":"MEUCIDjAwTdlMzcgcBAjYbWQlmRfcJd7yVC8S4fUr1Hf72x2AiEAsol30+SJCNRsBYQOEKD6DXbr8ODRGqiuqlpfoCECvSQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFjYd4E26l/ASjJ6gbWXH0aln2dEFXq7ptkLhpBY2u2fAiBbHUuXtDw/l/iJKm5ZkzeWFJZ29J7FE5xCSBJi2jLBzg=="}],"unpackedSize":565502},"main":"./cjs/index.js","name":"@dynatrace-sdk/client-synthetic","_from":"file:dynatrace-sdk-client-synthetic-4.0.0.tgz","types":"./types/index.d.ts","module":"./esm/index.js","license":"Apache-2.0","version":"4.0.0","_npmUser":{"name":"dynatrace-nodejs","email":"nodejs@dynatrace.com"},"_resolved":"/tmp/npm-publish-@dynatrace-sdk-client-synthetic-4.0.0-B8dJVg/dynatrace-sdk-client-synthetic-4.0.0.tgz","_integrity":"sha512-fipSb31PT5GHx5BqQT60Ej5HahCLoROJCZO0uVXHFRehnMa3XJpwDDfZScJqJbtDXDL/ovjqE0f+lzAbequCXQ==","_npmVersion":"11.16.0","description":"[![npm](https://img.shields.io/badge/npm-v4.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-synthetic/v/4.0.0) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)","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"}],"_nodeVersion":"24.18.0","dependencies":{"@dynatrace-sdk/http-client":"^1.5.1","@dynatrace-sdk/shared-errors":"^1.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/client-synthetic_4.0.0_1790240485552_0.35961535979570347"}}},"time":{"created":"2026-05-14T10:42:25.536Z","modified":"2026-09-24T09:01:25.930Z","1.0.0":"2026-05-14T10:42:25.825Z","2.0.0":"2026-07-17T08:41:02.317Z","3.0.0":"2026-08-12T12:50:40.906Z","4.0.0":"2026-09-24T09:01:25.637Z"},"license":"Apache-2.0","description":"[![npm](https://img.shields.io/badge/npm-v4.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-synthetic/v/4.0.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-synthetic\n\n[![npm](https://img.shields.io/badge/npm-v4.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-synthetic/v/4.0.0)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\nManage synthetic monitors, locations, nodes, and on-demand executions.\n\nTo authorize, use a valid OAuth token.\n\nNotes about compatibility:\n* Operations marked as early adopter or preview may be changed in non-compatible ways, although we try to avoid this.\n* We may add new enum constants without incrementing the API version; thus, clients need to handle unknown enum constants gracefully.\n\n\n## Installation\n\n```bash\nnpm install @dynatrace-sdk/client-synthetic\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-synthetic/).\n\n## syntheticConfigurationClient\n\n```js\nimport { syntheticConfigurationClient } from '@dynatrace-sdk/client-synthetic';\n```\n\n\n<a name=\"getconfiguration\"></a>\n### getConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticConfigurationClient.getConfiguration(config): Promise&lt;<a href=\"#syntheticconfigresponse\">SyntheticConfigResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nGets the set of synthetic-related parameters defined for the whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:environment-configuration:read\n\n\n\n</div>\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticConfigResponse](#syntheticconfigresponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticConfigurationClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticConfigurationClient.getConfiguration();\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"updateconfiguration\"></a>\n### updateConfiguration\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticConfigurationClient.updateConfiguration(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nUpdates the set of synthetic-related parameters defined for the whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:environment-configuration:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#syntheticconfigrequest\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticConfigRequest</a>|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. The set of synthetic-related parameters has been updated. The response doesn&apos;t have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticConfigurationClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticConfigurationClient.updateConfiguration({\n    body: {},\n  });\n```\n\n</details>\n\n\n\n</div>\n\n## syntheticLocationsClient\n\n```js\nimport { syntheticLocationsClient } from '@dynatrace-sdk/client-synthetic';\n```\n\n\n<a name=\"addlocation\"></a>\n### addLocation\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.addLocation(config): Promise&lt;<a href=\"#syntheticlocationidsresponse\">SyntheticLocationIdsResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nCreates a new private synthetic location. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#syntheticprivatelocationdto\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticPrivateLocationDto</a>|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticLocationIdsResponse](#syntheticlocationidsresponse)|201|Success. The private location has been created. The response contains the ID of the new location.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticLocationsClient.addLocation({\n  body: {\n    latitude: 10,\n    longitude: 10,\n    name: \"...\",\n    nodes: [\"...\"],\n    type: \"CLUSTER\",\n  },\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getlocation\"></a>\n### getLocation\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.getLocation(config): Promise&lt;<a href=\"#syntheticprivatelocationdto\">SyntheticPrivateLocationDto</a> &#124; <a href=\"#syntheticpubliclocationdto\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticPublicLocationDto</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nGets properties of the specified location. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required location.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticPrivateLocationDto](#syntheticprivatelocationdto)|200|Success. The response contains parameters of the synthetic location.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticLocationsClient.getLocation({\n  locationId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getlocationdeploymentyaml\"></a>\n### getLocationDeploymentYaml\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.getLocationDeploymentYaml(config): Promise&lt;Binary&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nGets the YAML file content to deploy a location in a Kubernetes/OpenShift cluster. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.activeGateName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the ActiveGate.|\n|config.customRegistry|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Custom image registry prefix; replaces <code>dynatrace</code> in image URLs in the generated YAML.|\n|config.locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required location.|\n|config.namespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target namespace.|\n|config.tagVersionActiveGate|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Custom version tag for ActiveGate; used as the desired ActiveGate version in the generated YAML.|\n|config.tagVersionSynthetic|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Custom version tag for Synthetic; used as the desired Synthetic version in the generated YAML.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The response contains the content of the YAML deployment file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticLocationsClient.getLocationDeploymentYaml({\n    locationId: \"...\",\n  });\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getlocations\"></a>\n### getLocations\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.getLocations(config): Promise&lt;<a href=\"#syntheticlocationsresponse\">SyntheticLocationsResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all synthetic locations (both public and private) available for your environment. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.capability|\"BROWSER\" &#124; \"HTTP\" &#124; \"HTTP_HIGH_RESOURCE\" &#124; \"ICMP\" &#124; \"TCP\" &#124; \"DNS\"|Filters the resulting set of locations to those that support a specific capability.|\n|config.cloudPlatform|\"AWS\" &#124; \"AZURE\" &#124; \"ALIBABA\" &#124; \"GOOGLE_CLOUD\" &#124; \"OTHER\"|Filters the resulting set of locations to those that are hosted on a specific cloud platform.|\n|config.type|\"PUBLIC\" &#124; \"PRIVATE\"|Filters the resulting set of locations to those of a specific type.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticLocationsResponse](#syntheticlocationsresponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticLocationsClient.getLocations();\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getlocationsstatus\"></a>\n### getLocationsStatus\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.getLocationsStatus(config): Promise&lt;<a href=\"#syntheticpubliclocationsstatusdto\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticPublicLocationsStatusDto</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nChecks the status of public synthetic locations. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:read\n\n\n\n</div>\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticPublicLocationsStatusDto](#syntheticpubliclocationsstatusdto)|200|Success. The response contains the public locations status.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticLocationsClient.getLocationsStatus();\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getmetricadapterdeploymentyaml\"></a>\n### getMetricAdapterDeploymentYaml\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.getMetricAdapterDeploymentYaml(config): Promise&lt;Binary&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nGets the YAML file content to deploy the metric adapter in a Kubernetes/OpenShift cluster. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.namespace|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The target namespace.|\n|config.platform|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The container platform. Currently supported values are <code>KUBERNETES</code> and <code>OPENSHIFT</code>. The default value is <code>KUBERNETES</code>.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. The response contains the content of the YAML deployment file.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticLocationsClient.getMetricAdapterDeploymentYaml();\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"removelocation\"></a>\n### removeLocation\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.removeLocation(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nDeletes the specified private synthetic location. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the private synthetic location to be deleted.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. The location has been deleted. Response doesn&apos;t have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticLocationsClient.removeLocation({\n  locationId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"updatelocation\"></a>\n### updateLocation\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.updateLocation(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nUpdates the specified synthetic location. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:write\n\nFor public locations you can only change the location status.\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#syntheticprivatelocationupdaterequest\">SyntheticPrivateLocationUpdateRequest</a> &#124; <a href=\"#syntheticpubliclocationupdaterequest\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticPublicLocationUpdateRequest</a>||\n|config.locationId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the synthetic location to be updated.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. The location has been updated. Response doesn&apos;t have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticLocationsClient.updateLocation({\n  locationId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"updatelocationsstatus\"></a>\n### updateLocationsStatus\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticLocationsClient.updateLocationsStatus(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nChanges the status of public synthetic locations. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#syntheticpubliclocationsstatusdto\">SyntheticPublicLocationsStatusDto</a>|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Locations status has been updated.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticLocationsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticLocationsClient.updateLocationsStatus({\n    body: { enabled: false },\n  });\n```\n\n</details>\n\n\n\n</div>\n\n## syntheticMonitorsClient\n\n```js\nimport { syntheticMonitorsClient } from '@dynatrace-sdk/client-synthetic';\n```\n\n\n<a name=\"createmonitor\"></a>\n### createMonitor\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticMonitorsClient.createMonitor(config): Promise&lt;<a href=\"#monitoridresponse\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorIdResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nCreates a synthetic monitor definition. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:monitors:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#browsermonitorrequest\">BrowserMonitorRequest</a> &#124; <a href=\"#httpmonitorrequest\" target=\"_blank\" rel=\"noopener noreferrer\">HttpMonitorRequest</a> &#124; <a href=\"#networkavailabilitymonitorrequest\">NetworkAvailabilityMonitorRequest</a>|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[MonitorIdResponse](#monitoridresponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticMonitorsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticMonitorsClient.createMonitor(\n  {},\n);\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"deletemonitor\"></a>\n### deleteMonitor\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticMonitorsClient.deleteMonitor(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nDeletes a synthetic monitor definition for the given monitor ID. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:monitors:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the monitor.|\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|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticMonitorsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticMonitorsClient.deleteMonitor({\n  monitorId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getmonitor\"></a>\n### getMonitor\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticMonitorsClient.getMonitor(config): Promise&lt;<a href=\"#browsermonitorresponse\" target=\"_blank\" rel=\"noopener noreferrer\">BrowserMonitorResponse</a> &#124; <a href=\"#httpmonitorresponse\">HttpMonitorResponse</a> &#124; <a href=\"#networkavailabilitymonitorresponse\" target=\"_blank\" rel=\"noopener noreferrer\">NetworkAvailabilityMonitorResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nGets a synthetic monitor definition for the given monitor ID. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:monitors:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the monitor.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[HttpMonitorResponse](#httpmonitorresponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticMonitorsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticMonitorsClient.getMonitor({\n  monitorId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getmonitors\"></a>\n### getMonitors\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticMonitorsClient.getMonitors(config): Promise&lt;<a href=\"#syntheticmonitorlistresponse\">SyntheticMonitorListResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nGets all synthetic monitors. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:monitors:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.monitorSelector|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Defines the scope of the query. Only monitors matching <strong>all</strong> criteria are included in the response.</p> <p>You can add one or more of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the <strong>OR</strong> logic applies.</p> <ul> <li>Monitor type: <code>type(HTTP,NETWORK_AVAILABILITY)</code>. Possible values: <code>HTTP</code>, <code>BROWSER</code>, <code>NETWORK_AVAILABILITY</code>.</li> <li>Synthetic Location ME ID: <code>location(SYNTHETIC_LOCATION-123)</code>.</li> <li>Monitored entity ID: <code>monitors(HOST-123,FRONTEND-456,SERVICE-789)</code>. Accepts HOST, application (<code>FRONTEND</code>), and SERVICE entity IDs.</li> <li>Manually assigned application ID: <code>isAssignedTo(FRONTEND-123)</code>. Accepts application (<code>FRONTEND</code>) IDs.</li> <li>Monitor tags: <code>tag(\\[context]key:value,key:value,key)</code>. Tags in <code>\\[context]key:value</code>, <code>key:value</code>, and <code>key</code> formats are detected and parsed automatically. If a key-only tag has a colon (<code>:</code>) in it, you must escape the colon with a backslash (<code>\\\\</code>). Otherwise, the tag will be parsed as a <code>key:value</code> tag. All tag values are case-sensitive. Values listed within a single <code>tag(...)</code> are combined with <strong>OR</strong>. To require multiple tags (<strong>AND</strong>), specify several <code>tag(...)</code> selectors. For example, <code>tag(tag-a),tag(tag-b)</code> matches only monitors that have <strong>both</strong> tags, while <code>tag(tag-a,tag-b)</code> matches monitors that have <strong>either</strong>.</li> <li>Monitor enablement: <code>enabled(true)</code>.</li> <li>Security context: <code>securityContext(value1,value2)</code>.</li> <li>Monaco external ID: <code>externalId(value1,value2)</code>.</li> </ul> <p>To set several criteria, separate them with a comma (<code>,</code>).</p> |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticMonitorListResponse](#syntheticmonitorlistresponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticMonitorsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticMonitorsClient.getMonitors();\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"updatemonitor\"></a>\n### updateMonitor\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticMonitorsClient.updateMonitor(config): Promise&lt;void&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nUpdates a synthetic monitor definition for the given monitor ID. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:monitors:write\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#browsermonitorrequest\" target=\"_blank\" rel=\"noopener noreferrer\">BrowserMonitorRequest</a> &#124; <a href=\"#httpmonitorrequest\">HttpMonitorRequest</a> &#124; <a href=\"#networkavailabilitymonitorrequest\" target=\"_blank\" rel=\"noopener noreferrer\">NetworkAvailabilityMonitorRequest</a>||\n|config.monitorId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the monitor.|\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|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticMonitorsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticMonitorsClient.updateMonitor({\n  monitorId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n## syntheticNodesClient\n\n```js\nimport { syntheticNodesClient } from '@dynatrace-sdk/client-synthetic';\n```\n\n\n<a name=\"getnode\"></a>\n### getNode\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticNodesClient.getNode(config): Promise&lt;<a href=\"#extendednoderesponse\">ExtendedNodeResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nGets properties of the specified synthetic node. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.nodeId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the required synthetic node.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[ExtendedNodeResponse](#extendednoderesponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticNodesClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticNodesClient.getNode({\n  nodeId: \"...\",\n});\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"getnodes\"></a>\n### getNodes\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticNodesClient.getNodes(config): Promise&lt;<a href=\"#nodesresponse\" target=\"_blank\" rel=\"noopener noreferrer\">NodesResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nLists all synthetic nodes available in your environment. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:locations:read\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.assignedToLocation|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true, returns the set of nodes that are assigned to a synthetic location. If set to false, returns only unassigned nodes. If omitted, returns both assigned and unassigned nodes.|\n|config.containerized|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If set to true, returns only containerized nodes. If set to false, returns only non-containerized nodes. If omitted, returns both containerized and non-containerized nodes.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[NodesResponse](#nodesresponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticNodesClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data = await syntheticNodesClient.getNodes();\n```\n\n</details>\n\n\n\n</div>\n\n## syntheticOnDemandMonitorExecutionsClient\n\n```js\nimport { syntheticOnDemandMonitorExecutionsClient } from '@dynatrace-sdk/client-synthetic';\n```\n\n\n<a name=\"executeondemand\"></a>\n### executeOnDemand\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticOnDemandMonitorExecutionsClient.executeOnDemand(config): Promise&lt;<a href=\"#syntheticondemandexecutionresponse\">SyntheticOnDemandExecutionResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nTriggers on-demand executions for synthetic monitors. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:monitors:execute\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type |\n| --- | --- |\n|config.body<sup>*required</sup>|<a href=\"#syntheticondemandexecutionrequest\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticOnDemandExecutionRequest</a>|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticOnDemandExecutionResponse](#syntheticondemandexecutionresponse)|201|Created|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticOnDemandMonitorExecutionsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticOnDemandMonitorExecutionsClient.executeOnDemand(\n    { body: {} },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n\n<a name=\"rerunondemandexecution\"></a>\n### rerunOnDemandExecution\n\n<div class=\"padding-bottom--md\">\n<strong>syntheticOnDemandMonitorExecutionsClient.rerunOnDemandExecution(config): Promise&lt;<a href=\"#syntheticondemandexecutionresponse\">SyntheticOnDemandExecutionResponse</a>&gt;</strong>\n\n<div class=\"padding-left--md\">\n\nReruns the specified on-demand synthetic monitor execution. | maturity=EARLY_ADOPTER\n\n**Required scope:** synthetic:monitors:execute\n\n\n\n</div>\n\n\n#### Parameters\n\n| Name | Type | Description |\n| --- | --- | --- |\n|config.executionId<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The ID of the on-demand execution.|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[SyntheticOnDemandExecutionResponse](#syntheticondemandexecutionresponse)|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|ErrorResponseEnvelopeError|Client side error. &#124; Server side error.|\n\n\n<details>\n<summary>\nCode example\n</summary>\n\n```ts\nimport { syntheticOnDemandMonitorExecutionsClient } from \"@dynatrace-sdk/client-synthetic\";\n\nconst data =\n  await syntheticOnDemandMonitorExecutionsClient.rerunOnDemandExecution(\n    { executionId: 10 },\n  );\n```\n\n</details>\n\n\n\n</div>\n\n## Types\n\n### AuthenticationDto\n\nAuthentication dto for Browser Monitor step.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|authServerAllowlist|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the allowed servers of KERBEROS authentication. Can be defined only for <code>KERBEROS</code> authentication type.|\n|domain|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|String containing the KERBEROS authentication domain. Can be defined only for <code>KERBEROS</code> authentication type.|\n|inputType<sup>*required</sup>|\"PLAIN\" &#124; \"SECURE\"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>SECURE</code> -&gt; SecureAuthenticationDto</li> <li><code>PLAIN</code> -&gt; PlainAuthenticationDto</li> </ul> |\n|type<sup>*required</sup>|\"HTTP_AUTHENTICATION\" &#124; \"KERBEROS\" &#124; \"WEBFORM\"|Type of authentication.|\n\n### BaseWaitConditionDto\n\nWait condition for Browser Monitor step.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|type<sup>*required</sup>|\"NETWORK\" &#124; \"NEXT_EVENT\" &#124; \"PAGE_COMPLETE\" &#124; \"TIME\" &#124; \"USER_ACTIONS\" &#124; \"VALIDATION\"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>TIME</code> -&gt; TimeWaitConditionDto</li> <li><code>VALIDATION</code> -&gt; ValidationWaitConditionDto</li> <li><code>PAGE_COMPLETE</code> -&gt; BaseWaitConditionDto</li> <li><code>NETWORK</code> -&gt; BaseWaitConditionDto</li> <li><code>NEXT_EVENT</code> -&gt; BaseWaitConditionDto</li> <li><code>USER_ACTIONS</code> -&gt; BaseWaitConditionDto</li> </ul> |\n\n### BrowserMonitorConfigurationDto\n\nBrowser Monitor configuration.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|blockedRequests|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|All requests matching the specified patterns will be blocked during the execution of the monitor.|\n|browserPermissions|<a href=\"#browserpermissionsdto\" target=\"_blank\" rel=\"noopener noreferrer\">BrowserPermissionsDto</a>|Permissions settings for browser.|\n|bypassCSP|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Bypass ContentSecurity Policy for monitored pages. If not defined in request, it will be set to false by default.|\n|chromiumStartupFlags|<a href=\"#chromiumstartupflagsdto\">ChromiumStartupFlagsDto</a>|Chromium startup flags of a Browser Monitor.|\n|clientCertificates|Array&lt;<a href=\"#clientcertificatedto\" target=\"_blank\" rel=\"noopener noreferrer\">ClientCertificateDto</a>&gt;|Identifier of stored client's certificate.|\n|cookies|Array&lt;<a href=\"#monitorcookiedto\">MonitorCookieDto</a>&gt;|Cookies list.|\n|device<sup>*required</sup>|<a href=\"#testdevicedto\" target=\"_blank\" rel=\"noopener noreferrer\">TestDeviceDto</a>|Test device of a Browser Monitor.|\n|enablement|<a href=\"#platformenablementdto\">PlatformEnablementDto</a>|Browser monitor enablement settings for 3rd gen.|\n|experimentalProperties|Array&lt;<a href=\"#browsermonitorpropertydto\" target=\"_blank\" rel=\"noopener noreferrer\">BrowserMonitorPropertyDto</a>&gt;|Experimental properties list.|\n|filteredRequests|<a href=\"#filteredrequestsdto\">FilteredRequestsDto</a>|Filtered requests of a Browser Monitor.|\n|ignoredErrorCodes|<a href=\"#ignorederrorcodesdto\" target=\"_blank\" rel=\"noopener noreferrer\">IgnoredErrorCodesDto</a>|Ignored Error Codes of a Browser Monitor.|\n|javaScriptSettings|<a href=\"#javascriptagentsettingsdto\">JavaScriptAgentSettingsDto</a>|JavaScript Agent Settings.|\n|monitorCrossOriginFrames|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture performance metrics for pages loaded in cross origin frames. If not defined in request, it will fall back to monitorFrames by default.|\n|monitorFrames|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture performance metrics for pages loaded in frames. If not defined in request, it will be set to false by default.|\n|networkThrottling|<a href=\"#networkthrottlingdto\" target=\"_blank\" rel=\"noopener noreferrer\">NetworkThrottlingDto</a>|Network throttling of a Browser Monitor.|\n|proxy|<a href=\"#proxydto\">ProxyDto</a>|Browser Monitor proxy.|\n|requestHeaderOptions|<a href=\"#requestheaderoptionsdto\" target=\"_blank\" rel=\"noopener noreferrer\">RequestHeaderOptionsDto</a>|Header Options of a Browser Monitor.|\n|useIESupportedAgent|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|useIESupportedAgent flag. If not defined in request, it will be set to false by default.|\n|userAgent|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|User agent.|\n\n### BrowserMonitorPropertyDto\n\nProperty of a Browser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Property name.|\n|value<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Property value.|\n\n### BrowserMonitorRequest\n\nBrowser monitor update.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|configuration<sup>*required</sup>|<a href=\"#browsermonitorconfigurationdto\">BrowserMonitorConfigurationDto</a>|Browser Monitor configuration.|\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description.|\n|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.<br/><br/><strong>Default:</strong> <code>true</code>|\n|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Stable identifier used by configuration-as-code tools (such as Monaco) to manage this monitor across environments. Unique per environment.|\n|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for NAM and HTTP, 15 minutes for BROWSER).|\n|keyPerformanceMetrics|<a href=\"#keyperformancemetricsdto\" target=\"_blank\" rel=\"noopener noreferrer\">KeyPerformanceMetricsDto</a>|The key performance metrics configuration.|\n|locations<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The locations to which the monitor is assigned.|\n|manuallyAssignedEntities|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Manually assigned entities.|\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|\n|outageHandling|<a href=\"#monitoroutagehandlingsettingsdto\">MonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|\n|performanceThresholds|<a href=\"#monitorperformancethresholdsdto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|\n|primaryGrailTags|Array&lt;<a href=\"#monitorprimarygrailtagdto\">MonitorPrimaryGrailTagDto</a>&gt;|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.|\n|securityContext|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|\\[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.|\n|steps<sup>*required</sup>|Array&lt;<a href=\"#browsermonitorstepdto\" target=\"_blank\" rel=\"noopener noreferrer\">BrowserMonitorStepDto</a>&gt;|The steps of the monitor.|\n|tags|Array&lt;<a href=\"#synthetictagwithsourcedto\">SyntheticTagWithSourceDto</a>&gt;|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |\n|type<sup>*required</sup>|\"BROWSER\"|Monitor type.|\n\n### BrowserMonitorResponse\n\nBrowser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|automaticallyAssignedEntities|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Automatically assigned entities.|\n|configuration<sup>*required</sup>|<a href=\"#browsermonitorconfigurationdto\" target=\"_blank\" rel=\"noopener noreferrer\">BrowserMonitorConfigurationDto</a>|Browser Monitor configuration.|\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description.|\n|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.|\n|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Stable identifier used by configuration-as-code tools (such as Monaco) to manage this monitor across environments. Unique per environment.|\n|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes.|\n|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The smartscape id of the monitor.|\n|keyPerformanceMetrics<sup>*required</sup>|<a href=\"#keyperformancemetricsdto\">KeyPerformanceMetricsDto</a>|The key performance metrics configuration.|\n|locations|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The locations to which the monitor is assigned.|\n|manuallyAssignedEntities|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Manually assigned entities.|\n|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification.|\n|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|\n|outageHandling<sup>*required</sup>|<a href=\"#monitoroutagehandlingsettingsdto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|\n|performanceThresholds|<a href=\"#monitorperformancethresholdsdto\">MonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|\n|primaryGrailTags|Array&lt;<a href=\"#monitorprimarygrailtagdto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorPrimaryGrailTagDto</a>&gt;|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.|\n|securityContext|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|\\[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.|\n|steps<sup>*required</sup>|Array&lt;<a href=\"#browsermonitorstepdto\">BrowserMonitorStepDto</a>&gt;|The steps of the monitor.|\n|tags|Array&lt;<a href=\"#synthetictagwithsourcedto\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticTagWithSourceDto</a>&gt;|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |\n|type<sup>*required</sup>|\"BROWSER\"|Monitor type.|\n\n### BrowserMonitorStepDto\n\nBase step of Browser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step Id.|\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|\n|type<sup>*required</sup>|\"CLICK\" &#124; \"COOKIE\" &#124; \"JAVASCRIPT\" &#124; \"KEYSTROKES\" &#124; \"NAVIGATE\" &#124; \"SELECT_OPTION\" &#124; \"TAP\"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -&gt; NavigateStepDto</li> <li><code>CLICK</code> -&gt; InteractionStepDto</li> <li><code>TAP</code> -&gt; InteractionStepDto</li> <li><code>KEYSTROKES</code> -&gt; KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -&gt; JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -&gt; SelectOptionStepDto</li> <li><code>COOKIE</code> -&gt; CookieStepDto</li> </ul> |\n\n### BrowserPermissionsDto\n\nPermissions settings for browser.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|camera|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Camera permission. If not defined in request, it will be set to false by default.|\n|location|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Location permission. If not defined in request, it will be set to false by default.|\n|microphone|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Microphone permission. If not defined in request, it will be set to false by default.|\n|notifications|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Notifications permission. If not defined in request, it will be set to false by default.|\n\n### ChromiumStartupFlagsDto\n\nChromium startup flags of a Browser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|autoplay-policy|\"no-user-gesture-required\" &#124; \"document-user-activation-required\"|autoplay-policy type.|\n|disable-features|<a href=\"#chromiumstartupflagsdtodisablefeatures\">ChromiumStartupFlagsDtoDisableFeatures</a>|disable-features map.|\n|disable-site-isolation-trials|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|disable-site-isolation-trials flag.|\n|disable-web-security|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|disable-web-security flag. If no value is passed, it will be set to false by default.|\n|host-resolver-rules|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|host-resolver-rules.|\n|ignore-certificate-errors|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|ignore-certificate-errors flag.|\n|ssl-version-max|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ssl-version-max.|\n|ssl-version-min|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|ssl-version-min.|\n|test-type|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|test-type flag.|\n\n### ChromiumStartupFlagsDtoDisableFeatures\n\ndisable-features map.\n\n**type**: Record&lt;string, boolean&gt;\n\n### ClientCertificateDto\n\nClient certificate.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|credentialId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Certificate CV id.|\n|domain<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Domain certificate will be applied to.|\n\n### ConstraintViolation\n\nInformation about a single constraint violation.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|context|<a href=\"#constraintviolationcontext\" target=\"_blank\" rel=\"noopener noreferrer\">ConstraintViolationContext</a>|<p>Structured context of the constraint violation. Well known keys that <strong>can</strong> be present are:</p> <ul> <li><code>reason</code> -&gt; Additional reasoning behind the occurred violation.</li> <li><code>pipeline</code> -&gt; Pipeline related to the violation.</li> <li><code>endpoint</code> -&gt; Endpoint related to the violation.</li> <li><code>stage</code> -&gt; Stage related to the violation.</li> <li><code>processor</code> -&gt; Processor related to the violation.</li> <li><code>routingRule</code> -&gt; Routing rule related to the violation.</li> </ul> |\n|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of the constraint violation.|\n\n### ConstraintViolationContext\n\nStructured context of the constraint violation.\nWell known keys that **can** be present are:\n* `reason` -&gt; Additional reasoning behind the occurred violation.\n* `pipeline` -&gt; Pipeline related to the violation.\n* `endpoint` -&gt; Endpoint related to the violation.\n* `stage` -&gt; Stage related to the violation.\n* `processor` -&gt; Processor related to the violation.\n* `routingRule` -&gt; Routing rule related to the violation.\n\n**type**: Record&lt;string, string&gt;\n\n### ConstraintViolationDetails\n\nList of encountered constraint violations.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|constraintViolations<sup>*required</sup>|Array&lt;<a href=\"#constraintviolation\">ConstraintViolation</a>&gt;|List of encountered constraint violations.|\n|type<sup>*required</sup>|\"constraintViolation\"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>constraintViolation</code> -&gt; ConstraintViolationDetails</li> </ul> |\n\n### CookieStepDto\n\nCookie step of Browser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|cookies<sup>*required</sup>|Array&lt;<a href=\"#monitorcookiedto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorCookieDto</a>&gt;|Field containing the list of cookies.|\n|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step Id.|\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|\n|type<sup>*required</sup>|\"CLICK\" &#124; \"COOKIE\" &#124; \"JAVASCRIPT\" &#124; \"KEYSTROKES\" &#124; \"NAVIGATE\" &#124; \"SELECT_OPTION\" &#124; \"TAP\"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -&gt; NavigateStepDto</li> <li><code>CLICK</code> -&gt; InteractionStepDto</li> <li><code>TAP</code> -&gt; InteractionStepDto</li> <li><code>KEYSTROKES</code> -&gt; KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -&gt; JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -&gt; SelectOptionStepDto</li> <li><code>COOKIE</code> -&gt; CookieStepDto</li> </ul> |\n\n### ErrorResponse\n\nBasic information of the encountered error.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The returned HTTP status code.|\n|details|<a href=\"#errorresponsedetails\">ErrorResponseDetails</a>|Detailed information of the error.|\n|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Description of the encountered error.|\n|reason|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Machine-readable reason for the error, if available.|\n\n### ErrorResponseDetails\n\nDetailed information of the error.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|type<sup>*required</sup>|\"constraintViolation\"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>constraintViolation</code> -&gt; ConstraintViolationDetails</li> </ul> |\n\n### ErrorResponseEnvelope\n\nEncloses the encountered error.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|error<sup>*required</sup>|<a href=\"#errorresponse\" target=\"_blank\" rel=\"noopener noreferrer\">ErrorResponse</a>|Basic information of the encountered error.|\n\n### ExtendedNodeResponse\n\nConfiguration of a synthetic node. Compare to NodeResponse contains additional browser-related data.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|activeGateVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the Active Gate.|\n|autoUpdateEnabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The Active Gate has the Auto update option enabled ('true') or not ('false').|\n|browserMonitorsEnabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The synthetic node is able to execute browser monitors (<code>true</code>) or not (<code>false</code>).|\n|browserType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The browser type.|\n|browserVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The browser version.|\n|capabilities<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The list of node's capabilities.|\n|healthCheckStatus<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The health check status of the synthetic node.|\n|hostname<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The hostname of the synthetic node.|\n|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the synthetic node.|\n|ips<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The IP of the synthetic node.|\n|oneAgentRoutingEnabled<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|The Active Gate has the One Agent routing enabled ('true') or not ('false').|\n|operatingSystem<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The Active Gate's host operating system.|\n|playerVersion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the synthetic player.|\n|status<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The status of the synthetic node.|\n|version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the synthetic node.|\n\n### FilteredRequestsDto\n\nFiltered requests of a Browser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|mode<sup>*required</sup>|\"BLOCK\" &#124; \"ALLOW\"|Filter mode for filtered requests.|\n|requests<sup>*required</sup>|Array&lt;<a href=\"#requestfilterdto\">RequestFilterDto</a>&gt;|Requests to be filtered.|\n\n### FrameworkOptionsDto\n\nJS framework options of a JS Agent.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|activeXObject|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|activeXObject support. If not defined in request, it will be set to false by default.|\n|angular|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Angular support. If not defined in request, it will be set to false by default.|\n|dojo|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Dojo support. If not defined in request, it will be set to false by default.|\n|extJs|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|extJs support. If not defined in request, it will be set to false by default.|\n|icefaces|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|icefaces support. If not defined in request, it will be set to false by default.|\n|jQuery|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|jquery support. If not defined in request, it will be set to false by default.|\n|mooTools|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|mooTools support. If not defined in request, it will be set to false by default.|\n|prototype|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|prototype support. If not defined in request, it will be set to false by default.|\n\n### HeaderDto\n\nA header of the request.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Header's name.|\n|value<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Header's value.|\n\n### HttpAuthenticationDto\n\nThe Http step&apos;s authentication.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|credentials<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Credential vault identifier.|\n|kdcIp|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|KDC IP in case KERBEROS auth type is selected.|\n|realmName|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Realm name in case KERBEROS type is selected.|\n|type<sup>*required</sup>|\"KERBEROS\" &#124; \"BASIC_AUTHENTICATION\" &#124; \"NTLM\"|Authentication type.|\n\n### HttpMonitorAdvancedSettingsDto\n\nHttp monitor&apos;s advanced settings.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|connectTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Connect timeout per request in ms.|\n|dnsQueryTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|DNS query timeout in ms.|\n|maxCustomScriptSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Maximum size of each pre- or post- execution script size in bytes.|\n|maxHeaderSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Maximum size of each request header in bytes.|\n|maxRequestBodySize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Maximum request body size in bytes.|\n|maxResponseBodyReadByScriptSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Maximum size of response body read by post-execution script in bytes.|\n|maxResponseBodySize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Maximum response body size in bytes.|\n|monitorExecutionTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Monitor execution timeout in ms.|\n|requestTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Request timeout in ms.|\n|scriptExecutionTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Pre- or post- execution script timeout in ms.|\n\n### HttpMonitorRequest\n\nHttp monitor&apos;s settings.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|advancedSettings|<a href=\"#httpmonitoradvancedsettingsdto\" target=\"_blank\" rel=\"noopener noreferrer\">HttpMonitorAdvancedSettingsDto</a>|Http monitor's advanced settings.|\n|cookies|Array&lt;<a href=\"#monitorcookiedto\">MonitorCookieDto</a>&gt;|The cookies of the monitor.|\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description.|\n|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.<br/><br/><strong>Default:</strong> <code>true</code>|\n|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Stable identifier used by configuration-as-code tools (such as Monaco) to manage this monitor across environments. Unique per environment.|\n|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes. Default value depends on the monitor type (1 minute for NAM and HTTP, 15 minutes for BROWSER).|\n|locations<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The locations to which the monitor is assigned.|\n|manuallyAssignedEntities|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Manually assigned entities.|\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|\n|outageHandling|<a href=\"#monitoroutagehandlingsettingsdto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|\n|performanceThresholds|<a href=\"#monitorperformancethresholdsdto\">MonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|\n|primaryGrailTags|Array&lt;<a href=\"#monitorprimarygrailtagdto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorPrimaryGrailTagDto</a>&gt;|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.|\n|securityContext|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|\\[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.|\n|steps<sup>*required</sup>|Array&lt;<a href=\"#httpmonitorstepdto\">HttpMonitorStepDto</a>&gt;|The steps of the monitor.|\n|tags|Array&lt;<a href=\"#synthetictagwithsourcedto\" target=\"_blank\" rel=\"noopener noreferrer\">SyntheticTagWithSourceDto</a>&gt;|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |\n|type<sup>*required</sup>|\"HTTP\"|Monitor type.|\n\n### HttpMonitorResponse\n\nHttp monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|advancedSettings|<a href=\"#httpmonitoradvancedsettingsdto\">HttpMonitorAdvancedSettingsDto</a>|Http monitor's advanced settings.|\n|automaticallyAssignedEntities|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Automatically assigned entities.|\n|cookies|Array&lt;<a href=\"#monitorcookiedto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorCookieDto</a>&gt;|The cookies of the monitor.|\n|description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Monitor description.|\n|enabled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true, the monitor is enabled.|\n|externalId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Stable identifier used by configuration-as-code tools (such as Monaco) to manage this monitor across environments. Unique per environment.|\n|frequencyMin|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The frequency of the monitor, in minutes.|\n|id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The smartscape id of the monitor.|\n|locations|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The locations to which the monitor is assigned.|\n|manuallyAssignedEntities|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|Manually assigned entities.|\n|modificationTimestamp|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The timestamp of the last modification.|\n|name|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the monitor.|\n|outageHandling<sup>*required</sup>|<a href=\"#monitoroutagehandlingsettingsdto\">MonitorOutageHandlingSettingsDto</a>|Outage handling configuration.|\n|performanceThresholds|<a href=\"#monitorperformancethresholdsdto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorPerformanceThresholdsDto</a>|Performance thresholds configuration.|\n|primaryGrailTags|Array&lt;<a href=\"#monitorprimarygrailtagdto\">MonitorPrimaryGrailTagDto</a>&gt;|Primary Grail tags as a list of key-value pairs. Up to 10 tags. Those fields are only available for SaaS and not for Managed.|\n|securityContext|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|\\[FEATURE DISABLED] Security context as a list of strings. Up to 10 values, max 200 characters per value. Those fields are only available for SaaS and not for Managed.|\n|steps<sup>*required</sup>|Array&lt;<a href=\"#httpmonitorstepdto\" target=\"_blank\" rel=\"noopener noreferrer\">HttpMonitorStepDto</a>&gt;|The steps of the monitor.|\n|tags|Array&lt;<a href=\"#synthetictagwithsourcedto\">SyntheticTagWithSourceDto</a>&gt;|<p>A set of tags assigned to the monitor.</p> <p>You can specify only the value of the tag here and the <code>CONTEXTLESS</code> context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.</p> |\n|type<sup>*required</sup>|\"HTTP\"|Monitor type.|\n\n### HttpMonitorStepDto\n\nThe step of a Http monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|authentication|<a href=\"#httpauthenticationdto\" target=\"_blank\" rel=\"noopener noreferrer\">HttpAuthenticationDto</a>|The Http step's authentication.|\n|configuration|<a href=\"#httpstepconfigurationdto\">HttpStepConfigurationDto</a>|The Http step's configuration.|\n|constraints<sup>*required</sup>|Array&lt;<a href=\"#monitorconstraintdto\" target=\"_blank\" rel=\"noopener noreferrer\">MonitorConstraintDto</a>&gt;|The list of constraints.|\n|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step Id.|\n|methodType<sup>*required</sup>|\"GET\" &#124; \"POST\" &#124; \"PUT\" &#124; \"DELETE\" &#124; \"HEAD\" &#124; \"OPTIONS\" &#124; \"PATCH\"|Method type.|\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step name.|\n|postScript|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|PostScript.|\n|preScript|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|PreScript.|\n|requestBody|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Request body.|\n|requestTimeout|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Request timeout in s.|\n|url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step url.|\n\n### HttpStepConfigurationDto\n\nThe Http step&apos;s configuration.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|acceptAnyCertificate|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true accept any certificate flag.<br/><br/><strong>Default:</strong> <code>true</code>|\n|clientCertificateId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Identifier of stored client's certificate.|\n|doNotPersistSensitiveData|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true the step's data aren't stored and displayed.<br/><br/><strong>Default:</strong> <code>false</code>|\n|followRedirects|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If true follow redirects.<br/><br/><strong>Default:</strong> <code>false</code>|\n|headers|Array&lt;<a href=\"#headerdto\">HeaderDto</a>&gt;|The headers.|\n|sslCertificateExpirationDaysToAlert|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of days within SSL certificate expires.|\n\n### IgnoredErrorCodesDto\n\nIgnored Error Codes of a Browser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|matchingDocumentRequests|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Ignoring status codes will be applied to requests matching pattern.|\n|statusCodes|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Status codes to be ignored.|\n\n### InteractionStepDto\n\nInteraction step of Browser Monitor.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|button<sup>*required</sup>|\"MOUSE_LEFT\" &#124; \"MOUSE_MIDDLE\" &#124; \"MOUSE_RIGHT\"|Integer containing the button index.|\n|id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Step Id.|\n|name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of Browser Monitor step.|\n|target|<a href=\"#targetdto\" target=\"_blank\" rel=\"noopener noreferrer\">TargetDto</a>|Target of Browser Monitor step.|\n|type<sup>*required</sup>|\"CLICK\" &#124; \"COOKIE\" &#124; \"JAVASCRIPT\" &#124; \"KEYSTROKES\" &#124; \"NAVIGATE\" &#124; \"SELECT_OPTION\" &#124; \"TAP\"|<p>Defines the actual set of fields depending on the value. See one of the following objects:</p> <ul> <li><code>NAVIGATE</code> -&gt; NavigateStepDto</li> <li><code>CLICK</code> -&gt; InteractionStepDto</li> <li><code>TAP</code> -&gt; InteractionStepDto</li> <li><code>KEYSTROKES</code> -&gt; KeyStrokesStepDto</li> <li><code>JAVASCRIPT</code> -&gt; JavaScriptStepDto</li> <li><code>SELECT_OPTION</code> -&gt; SelectOptionStepDto</li> <li><code>COOKIE</code> -&gt; CookieStepDto</li> </ul> |\n|validationRules|Array&lt;<a href=\"#validationruledto\">ValidationRuleDto</a>&gt;|List of validation rules for the step to perform.|\n|waitCondition|<a href=\"#basewaitconditiondto\" target=\"_blank\" rel=\"noopener noreferrer\">BaseWaitConditionDto</a>|Wait condition for Browser Monitor step.|\n\n### JavaScriptAgentSettingsDto\n\nJavaScript Agent Settings.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|customProperties|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Custom configuration properties.|\n|experimentalValues|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Experimental values support. If not defined in request, it will be set to false by default.|\n|fetchRequests|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Capture fetch() requests. If not defined in request, it will be set to true by default.|\n|javaScriptErrors|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Enable this setting to monitor JavaScript errors. The window.onError handler is used for capturing JavaScript errors. If not defined in request, it will be set to true by default.|\n|javaScriptFrameworkSupport|<a href=\"#fram","readmeFilename":"README.md"}