Settings API - Network Availability monitor config schema table
Network Availability monitor config (builtin:synthetic.multiprotocol.config)
Network Availability monitor
Schema ID | Schema groups | Scope |
---|---|---|
builtin:synthetic.multiprotocol.config |
| MULTIPROTOCOL_MONITOR - Network availability monitor |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.multiprotocol.config |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.multiprotocol.config | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.multiprotocol.config |
Authentication
To execute this request, you need an access token with Read settings (settings.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Property | Type | Description | Required |
---|---|---|---|
Monitor enabledenabled | boolean | - | required |
Monitor descriptiondescription | text | - | required |
Stepssteps | Step[] | - | required |
Monitor propertiesproperties | Set<Property> | Option not supported yet | required |
The Step
object
Property | Type | Description | Required |
---|---|---|---|
Step namename | text | - | required |
Request typerequestType | enum | All steps in the monitor must be the same request type. Learn more about request types in Dynatrace documentation
| required |
Target listtargetList | set | - | required |
Target filtertargetFilter | text | See syntax and examples in Dynatrace documentation | optional |
Configuration propertiesproperties | Set<Property> | See possible configuration properties in Dynatrace documentation | required |
Step-level constraintsconstraints | Set<Constraint> | See possible step-level constraints in Dynatrace documentation | required |
Request-level configurationrequestConfigurations | Set<RequestConfiguration> | See possible request-level configurations in Dynatrace documentation for ICMP, TCP and DNS requests. | required |
Pre-execution scriptpreScript | text | Option not supported yet | optional |
Post-execution scriptpostScript | text | Option not supported yet | optional |
The Property
object
Property | Type | Description | Required |
---|---|---|---|
Property keykey | text | - | required |
Property valuevalue | text | - | required |
The Constraint
object
Property | Type | Description | Required |
---|---|---|---|
Constraint typetype | text | - | required |
Propertiesproperties | Set<Property> | - | required |
The RequestConfiguration
object
Property | Type | Description | Required |
---|---|---|---|
Request constraintsconstraints | Set<Constraint> | - | required |
Propertiesproperties | Set<Property> | Option not supported yet | required |
Pattern matcherpatternMatcher | text | Option not supported yet | optional |