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 IDSchema groupsScope
app:dynatrace.biz.carbon:cost-and-carbon-settings-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/app:dynatrace.biz.carbon:cost-and-carbon-settings
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/app:dynatrace.biz.carbon:cost-and-carbon-settings
Environment ActiveGatehttps://{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

PropertyTypeDescriptionRequired
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
Data center overrides
customDatacenterOverrides		TDataCenterValueOverrides[]-Required
Business health performance indicator
businessHealth		TBusinessHealth-Optional
The TThreshold object
PropertyTypeDescriptionRequired
Network Receiving
networkReceiving		TNetworkThreshold-Required
Network Transmitting
networkTransmitting		TNetworkThreshold-Required
Cpu
cpu		TCpuThreshold-Required
Memory
memory		TCpuThreshold-Required
The TDataCenterValueOverrides object
PropertyTypeDescriptionRequired
Data Center Id
dataCenterId		text-Optional
Id
pue		float-Optional
Carbon Intensity
ci		float-Optional
PUE last update
pueLastUpdate		zoned_date_time-Optional
Carbon Intensity last update
ciLastUpdate		zoned_date_time-Optional
The TBusinessHealth object
PropertyTypeDescriptionRequired
Event
event		TBusinessEvent-Required
The TNetworkThreshold object
PropertyTypeDescriptionRequired
Value
value		integer-Required
Unit
unit		enum
The element has these enums
  • bytes/s
  • kilobytes/s
  • megabytes/s
  • gigabytes/s
Required
The TCpuThreshold object
PropertyTypeDescriptionRequired
CPU threshold [%]
value		integer-Required
Unit
unit		enum
The element has these enums
  • %
Required
The TBusinessEvent object
PropertyTypeDescriptionRequired
Select event
id		TBusinessEventId-Optional
Select KPI
attribute		text-Optional
KPI unit
unit		text-Optional
The TBusinessEventId object
PropertyTypeDescriptionRequired
Provider
provider		text-Required
Name
name		text-Required