Settings 2.0 - Availability cards schema

Availability cards (`builtin:ua.availability-card`)

Specifies the behavior of availability card. Thresholds, metric and entity selectors, etc.

Schema ID	Schema groups	Scope
`builtin:ua.availability-card`	`group:unified-analysis`	`environment`

Retrieve schema via Settings API

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

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
key	Key	text	Unique key, which is used to map to this availability card in the screen layout config	required
displayName	Display name	text	The title of the availability card.	optional
description	Description	text	The description of the card Markdown syntax can be used to enrich description. To define a link, you can only use seaOtter links (https://dt-url.net/XXXXXXX) or action expression The format of a single action expression is: actionName\|key=param\|key2=param2	optional
metricSelector	Metric selector expression	text	A metric selector expression for a dedicated metric line	required
entitySelectorTemplate	Entity selector template	text	An optional entity selector template	optional
showSummary	Show availability summary	boolean	Enable or disable average availability summary in percent over selected timeframe	required
defaultValue	Default value	integer	A value that replace missing values	required
thresholds	Availability thresholds	set	Configure availability thresholds	required

Request body objects

The `Threshold` object

Property	Label	Type	Description	Required
label	Threshold label	text	A label of threshold shown in chart legend	required
value	Threshold minimum value	integer	Values equal and greater than that value are assigned to threshold	required
color	Threshold color	text	A color shown on availability chart assigned to this threshold	required