Settings API - Cost & Carbon Optimization schema table

Published Mar 17, 2025

Cost & Carbon Optimization (`app:dynatrace.biz.carbon:cost-and-carbon-settings)`

Settings for the Cost & Carbon Optimization AppEngine application.

Schema ID	Schema groups	Scope
`app:dynatrace.biz.carbon:cost-and-carbon-settings`	-	`environment`

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.biz.carbon:cost-and-carbon-settings`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:dynatrace.biz.carbon:cost-and-carbon-settings`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.biz.carbon:cost-and-carbon-settings`

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
Workflow ID `workflowId`	text	-	optional
GCP API key `gcpApiKey`	secret	-	optional
Should collect costs `isCostCollected`	boolean	-	optional
Idling optimization `idlingThresholds`	TThreshold	-	optional
Sizing optimization `sizingThresholds`	TThreshold	-	optional
Business health performance indicator `businessHealth`	TBusinessHealth	-	optional

The `TThreshold` object

Property	Type	Description	Required
Network Receiving `networkReceiving`	TNetworkThreshold	-	required
Network Transmitting `networkTransmitting`	TNetworkThreshold	-	required
Cpu `cpu`	TCpuThreshold	-	required
Memory `memory`	TCpuThreshold	-	required

The `TBusinessHealth` object

Property	Type	Description	Required
Event `event`	TBusinessEvent	-	required

The `TNetworkThreshold` object

Property	Type	Description	Required
Value `value`	integer	-	required
Unit `unit`	enum	`bytes/s` `kilobytes/s` `megabytes/s` `gigabytes/s`	required

The `TCpuThreshold` object

Property	Type	Description	Required
CPU threshold [%] `value`	integer	-	required
Unit `unit`	enum	`%`	required

The `TBusinessEvent` object

Property	Type	Description	Required
Select event `id`	TBusinessEventId	-	optional
Select KPI `attribute`	text	-	optional
KPI unit `unit`	text	-	optional

The `TBusinessEventId` object

Property	Type	Description	Required
Provider `provider`	text	-	required
Name `name`	text	-	required