Settings API - Cost & Carbon Optimization schema table

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
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
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 TBusinessHealth object
PropertyTypeDescriptionRequired
Event
event
TBusinessEvent-required
The TNetworkThreshold object
PropertyTypeDescriptionRequired
Value
value
integer-required
Unit
unit
enum
  • bytes/s
  • kilobytes/s
  • megabytes/s
  • gigabytes/s
required
The TCpuThreshold object
PropertyTypeDescriptionRequired
CPU threshold [%]
value
integer-required
Unit
unit
enum
  • %
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