Settings API - Process availability schema table

Process availability (`builtin:processavailability)`

This feature allows you to monitor if at least one process matching the specified monitoring rule exists on your host. If no process running on your host matches the rule, you receive an alert. If you also enable Process instance snapshots, you receive a detailed report on the activity of the most resource-consuming processes, as well as on the latest activity of the processes matching the rule.

In order to monitor the availability of a certain group of processes, you must first define a monitoring rule. Give your monitoring rule a unique name and add its detection rules to which Dynatrace will match the processes on your host.

For more details, see Process availability

Schema ID	Schema groups	Scope
`builtin:processavailability`	`group:processes-and-containers.processes` `group:processes-and-containers`	`HOST` - Host `HOST_GROUP` - Host Group `environment`

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:processavailability`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:processavailability`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:processavailability`

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	Label	Type	Description	Required
enabled	Enabled	boolean	-	required
name	Monitored rule name	text	-	required
rules	Define detection rules	list	Define process detection rules by selecting a process property and a condition. Each monitoring rule can have multiple detection rules associated with it.	required
metadata	Properties	set	Set of additional key-value properties to be attached to the triggered event.	required

Request body objects

The `MetadataItem` object

Property	Label	Type	Description	Required
metadataKey	Key	text	Type 'dt.' for key hints.	required
metadataValue	Value	text	Type '{' for placeholder hints.	required

The `DetectionCondition` object

Property	Label	Type	Description	Required
property	Select process property	enum	-	required
condition	Condition	text	$contains(svc) – Matches if svc appears anywhere in the process property value. $eq(svc.exe) – Matches if svc.exe matches the process property value exactly. $prefix(svc) – Matches if app matches the prefix of the process property value. $suffix(svc.py) – Matches if svc.py matches the suffix of the process property value. For example, $suffix(svc.py) would detect processes named loyaltysvc.py and paymentssvc.py. For more details, see Process availability.	required

Property

Label

Type

Description

Required

property

Select process property

enum

required

condition

Condition

text

$contains(svc) – Matches if svc appears anywhere in the process property value.
$eq(svc.exe) – Matches if svc.exe matches the process property value exactly.
$prefix(svc) – Matches if app matches the prefix of the process property value.
$suffix(svc.py) – Matches if svc.py matches the suffix of the process property value.

For example, $suffix(svc.py) would detect processes named loyaltysvc.py and paymentssvc.py.

For more details, see Process availability.