The instana service has 23 resource kinds, each listed below with its endpoints, fields, and dependencies. Values resolve late, so you reference another resource with ${kind.ref_name}. For defaults, validation rules, and examples, run wxctl explain <kind>.
  • Envelope: A config is one or more YAML documents separated by ---. Each has top-level kind and ref_name, then the fields below at the top level (not nested under spec).
  • ref_name: Unique handle for this resource within the config. Used to reference it from other resources, then stripped before the API call (not a schema field).
  • References: Reference another resource by its ref_name: ${<kind>.<ref_name>} resolves to its id, ${<kind>.<ref_name>.<field>} to a specific field. Values resolve late, at plan/apply time.

​
instana_alert

An Instana alerting configuration (AlertingConfiguration, /api/events/settings/alerts) routes events that match an event filter to one or more alerting channels, the only API mechanism for delivering custom-event notifications to an external channel. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/alerts/{id}
ReadGET/api/events/settings/alerts/{id}
ListGET/api/events/settings/alerts
UpdatePUT/api/events/settings/alerts/{id}
DeleteDELETE/api/events/settings/alerts/{id}
Fields
FieldTypeRequiredDescription
idstringRequiredCLIENT-SUPPLIED alerting-configuration id. Required in the AlertingConfiguration PUT body AND the get_by_id discovery id_source (delete.rs/update.rs substitute it into /{id}). Immutable, a different id is a different configuration.
alertNamestringRequiredAlerting-configuration display name.
integrationIdsarray<string>RequiredIds of the alerting channels matched events route to. references on this top-level array field produces a DAG edge (build.rs edges any field with a references block, scalar or array) → channels are ordered before this configuration and each ${instana_alerting_channel.<ref>.id} element resolves. Proven pattern: alertChannelIds on the four alert-config kinds.
eventFilteringConfigurationobjectRequiredEventFilteringConfiguration selecting which events trigger this configuration. ruleIds scopes to specific custom event specifications; eventTypes/query/applicationAlertConfigIds narrow further.
customPayloadFieldsarray<object>OptionalCustom key/value fields attached to routed events. API-required, but default: [] (with schema required:false, per the agent.yaml pattern) lets configs omit it, always sent as [] on the wire. Rides the PUT body; the default update path would prune it, so update is handler-owned.
muteUntilintegerOptionalAbsolute epoch-MILLISECONDS timestamp until which this configuration is muted, NOT a duration. 0 = enabled (not muted). The declarative on-stage mute knob: set to a far-future epoch to silence delivery, revert to 0 to resume.
includeEntityNameInLegacyAlertsbooleanOptionalInclude the entity name in legacy alert payloads (server default).
Depends on
  • integrationIds → instana_alerting_channel (required)
  • eventFilteringConfiguration.ruleIds → instana_custom_event_spec (optional)

​
instana_alerting_channel

An Instana alerting channel (AbstractIntegration) is a notification target, email, Slack, generic webhook, PagerDuty, Opsgenie, Splunk, and more, that smart-alert configs route events to. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/alertingChannels
ReadGET/api/events/settings/alertingChannels/{id}
ListGET/api/events/settings/alertingChannels
UpdatePUT/api/events/settings/alertingChannels/{id}
DeleteDELETE/api/events/settings/alertingChannels/{id}
Fields
FieldTypeRequiredDescription
idstringRequiredCLIENT-SUPPLIED alerting-channel id (Instana 3.319 rejects id-less creates with a 500). Immutable, a different id is a different channel.
channel_typestringRequiredChannel-type discriminator selecting which per-type fields apply (sent as the wire field kind).
namestringRequiredChannel display name; Instana’s human identifier (matched on during discovery).
emailsarray<string>OptionalEMAIL, recipient addresses.
webhookUrlstringOptionalSLACK / single-URL webhook, incoming webhook URL (credential; redacted at emission).
webhookUrlsarray<string>OptionalWEB_HOOK, generic webhook target URLs (credentials; redacted at emission).
channelstringOptionalSLACK, target channel name.
iconUrlstringOptionalSLACK, message icon URL.
headersarray<string>OptionalWEB_HOOK, extra HTTP headers sent with the webhook call.
urlstringOptionalSPLUNK / generic, endpoint URL.
tokenstringOptionalSPLUNK, HEC token (credential; redacted at emission).
apiKeystringOptionalOPS_GENIE / VICTOR_OPS, API key (credential; redacted at emission).
regionstringOptionalOPS_GENIE, API region.
tagsstringOptionalOPS_GENIE, comma-separated alert tags.
serviceIntegrationKeystringOptionalPAGER_DUTY, service integration key (credential; redacted at emission).
routingKeystringOptionalVICTOR_OPS, routing key (credential; redacted at emission).
appIdstringOptionalBIDIRECTIONAL_MS_TEAMS, Teams app id.
tenantIdstringOptionalBIDIRECTIONAL_MS_TEAMS, Teams tenant id.
clientIdstringOptionalOAuth-based channels (Teams / Salesforce), client id.
clientSecretstringOptionalOAuth-based channels, client secret (credential; redacted at emission).
usernamestringOptionalSALESFORCE / SERVICE_NOW, account username.
passwordstringOptionalSALESFORCE / SERVICE_NOW, account password (credential; redacted at emission).
salesforceUrlstringOptionalSALESFORCE, instance URL.
serviceNowUrlstringOptionalSERVICE_NOW, instance URL.
Consumers
  • instana_alert → .integrationIds (required)
  • instana_application_alert_config → .alertChannelIds (required)
  • instana_infra_alert_config → .alertChannelIds (optional)
  • instana_log_alert_config → .alertChannelIds (optional)
  • instana_slo_alert_config → .alertChannelIds (required)
  • instana_synthetic_alert_config → .alertChannelIds (required)
  • instana_website_alert_config → .alertChannelIds (optional)

​
instana_api_token

An Instana API token (ApiToken) created via /api/settings/api-tokens; the identity is a CLIENT-SUPPLIED internalId (also the path param), the human identifier is name. Runs on SaaS + Software · ID field internalId Endpoints
OperationMethodPath
CreatePOST/api/settings/api-tokens
ReadGET/api/settings/api-tokens/{internalId}
ListGET/api/settings/api-tokens
UpdatePUT/api/settings/api-tokens/{internalId}
DeleteDELETE/api/settings/api-tokens/{internalId}
Fields
FieldTypeRequiredDescription
internalIdstringRequiredCLIENT-SUPPLIED api-token id (path identity / id_field). Immutable — a different internalId is a different token.
namestringRequiredToken display name; Instana’s human identifier (matched on during discovery).
accessGrantingTokenstringRequiredThe token’s secret bearer value (credential; redacted at emission). Supply via ${env:INSTANA_APITOKEN_GRANT} in examples, never inline.
expiresOnintegerOptionalToken expiry, epoch milliseconds. Omit for a non-expiring token.
canConfigureAgentRunModebooleanOptionalCan configure agent run mode.
canConfigureAgentsbooleanOptionalCan configure agents.
canConfigureAiAgentsbooleanOptionalCan configure AI agents.
canConfigureApdexbooleanOptionalCan configure apdex.
canConfigureApiTokensbooleanOptionalCan configure API tokens.
canConfigureApplicationSmartAlertsbooleanOptionalCan configure application smart alerts.
canConfigureApplicationsbooleanOptionalCan configure applications.
canConfigureAuthenticationMethodsbooleanOptionalCan configure authentication methods.
canConfigureAutomationActionsbooleanOptionalCan configure automation actions.
canConfigureAutomationPoliciesbooleanOptionalCan configure automation policies.
canConfigureBizopsbooleanOptionalCan configure BizOps.
canConfigureDatabaseManagementbooleanOptionalCan configure database management.
canConfigureEumApplicationsbooleanOptionalCan configure EUM applications.
canConfigureEventsAndAlertsbooleanOptionalCan configure events and alerts.
canConfigureGlobalAlertPayloadbooleanOptionalCan configure global alert payload.
canConfigureGlobalApplicationSmartAlertsbooleanOptionalCan configure global application smart alerts.
canConfigureGlobalInfraSmartAlertsbooleanOptionalCan configure global infra smart alerts.
canConfigureGlobalLogSmartAlertsbooleanOptionalCan configure global log smart alerts.
canConfigureGlobalSyntheticSmartAlertsbooleanOptionalCan configure global synthetic smart alerts.
canConfigureIntegrationsbooleanOptionalCan configure integrations.
canConfigureLLMbooleanOptionalCan configure LLM.
canConfigureLogManagementbooleanOptionalCan configure log management.
canConfigureLogRetentionPeriodbooleanOptionalCan configure log retention period.
canConfigureMaintenanceWindowsbooleanOptionalCan configure maintenance windows.
canConfigureMobileAppMonitoringbooleanOptionalCan configure mobile app monitoring.
canConfigureMobileAppSmartAlertsbooleanOptionalCan configure mobile app smart alerts.
canConfigurePersonalApiTokensbooleanOptionalCan configure personal API tokens.
canConfigureReleasesbooleanOptionalCan configure releases.
canConfigureServiceLevelCorrectionWindowsbooleanOptionalCan configure service level correction windows.
canConfigureServiceLevelSmartAlertsbooleanOptionalCan configure service level smart alerts.
canConfigureServiceLevelsbooleanOptionalCan configure service levels.
canConfigureServiceMappingbooleanOptionalCan configure service mapping.
canConfigureSessionSettingsbooleanOptionalCan configure session settings.
canConfigureSubtracesbooleanOptionalCan configure subtraces.
canConfigureSyntheticCredentialsbooleanOptionalCan configure synthetic credentials.
canConfigureSyntheticLocationsbooleanOptionalCan configure synthetic locations.
canConfigureSyntheticTestsbooleanOptionalCan configure synthetic tests.
canConfigureTeamsbooleanOptionalCan configure teams.
canConfigureUsersbooleanOptionalCan configure users.
canConfigureWebsiteSmartAlertsbooleanOptionalCan configure website smart alerts.
canCreateHeapDumpbooleanOptionalCan create heap dump.
canCreatePublicCustomDashboardsbooleanOptionalCan create public custom dashboards.
canCreateThreadDumpbooleanOptionalCan create thread dump.
canDeleteAutomationActionHistorybooleanOptionalCan delete automation action history.
canDeleteLogsbooleanOptionalCan delete logs.
canEditAllAccessibleCustomDashboardsbooleanOptionalCan edit all accessible custom dashboards.
canInstallNewAgentsbooleanOptionalCan install new agents.
canInvokeAlertChannelbooleanOptionalCan invoke alert channel.
canManuallyCloseIssuebooleanOptionalCan manually close issue.
canRunAutomationActionsbooleanOptionalCan run automation actions.
canUseSyntheticCredentialsbooleanOptionalCan use synthetic credentials.
canViewAccountAndBillingInformationbooleanOptionalCan view account and billing information.
canViewAuditLogbooleanOptionalCan view audit log.
canViewBizAlertsbooleanOptionalCan view biz alerts.
canViewBusinessActivitiesbooleanOptionalCan view business activities.
canViewBusinessProcessDetailsbooleanOptionalCan view business process details.
canViewBusinessProcessesbooleanOptionalCan view business processes.
canViewLogVolumebooleanOptionalCan view log volume.
canViewLogsbooleanOptionalCan view logs.
canViewSyntheticLocationsbooleanOptionalCan view synthetic locations.
canViewSyntheticTestResultsbooleanOptionalCan view synthetic test results.
canViewSyntheticTestsbooleanOptionalCan view synthetic tests.
canViewTraceDetailsbooleanOptionalCan view trace details.
limitedAiGatewayScopebooleanOptionalRestrict token to AI Gateway scope.
limitedAlertChannelsScopebooleanOptionalRestrict token to alert channels scope.
limitedApplicationsScopebooleanOptionalRestrict token to applications scope.
limitedAutomationScopebooleanOptionalRestrict token to automation scope.
limitedBizOpsScopebooleanOptionalRestrict token to biz ops scope.
limitedGenAIScopebooleanOptionalRestrict token to gen AI scope.
limitedInfrastructureScopebooleanOptionalRestrict token to infrastructure scope.
limitedKubernetesScopebooleanOptionalRestrict token to kubernetes scope.
limitedLinuxKVMHypervisorScopebooleanOptionalRestrict token to linux KVM hypervisor scope.
limitedLogsScopebooleanOptionalRestrict token to logs scope.
limitedMobileAppsScopebooleanOptionalRestrict token to mobile apps scope.
limitedNutanixScopebooleanOptionalRestrict token to nutanix scope.
limitedOpenstackScopebooleanOptionalRestrict token to openstack scope.
limitedPcfScopebooleanOptionalRestrict token to PCF (Pivotal Cloud Foundry) scope.
limitedPhmcScopebooleanOptionalRestrict token to PowerVM HMC scope.
limitedPvcScopebooleanOptionalRestrict token to PVC scope.
limitedServiceLevelScopebooleanOptionalRestrict token to service level scope.
limitedSyntheticsScopebooleanOptionalRestrict token to synthetics scope.
limitedVsphereScopebooleanOptionalRestrict token to vsphere scope.
limitedWebsitesScopebooleanOptionalRestrict token to websites scope.
limitedWindowsHypervisorScopebooleanOptionalRestrict token to windows hypervisor scope.
limitedXenServerScopebooleanOptionalRestrict token to XenServer scope.
limitedZhmcScopebooleanOptionalRestrict token to zHMC scope.
Computed outputs: id.

​
instana_application_alert_config

An Instana application smart alert (ApplicationAlertConfig) evaluates a rule (erroneous-call-rate, latency, throughput, …) over an application perspective’s calls and routes triggered events to alerting channels. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/application-alert-configs
ReadGET/api/events/settings/application-alert-configs/{id}
ListGET/api/events/settings/application-alert-configs
UpdatePOST/api/events/settings/application-alert-configs/{id}
DeleteDELETE/api/events/settings/application-alert-configs/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredSmart-alert display name; Instana’s human identifier (matched on during discovery).
descriptionstringRequiredAlert description shown on triggered events.
alertChannelIdsarray<string>RequiredIds of the alerting channels triggered events route to. references on this array field DOES produce a DAG edge (build.rs edges any field with a references block, scalar or array) → channels are ordered before this alert and each ${instana_alerting_channel.<ref>.id} element resolves.
applicationsobjectOptionalScoping map keyed by application-perspective id. OMIT this field and scope via the top-level applicationId instead: the live API requires exactly one entry whose KEY equals the value’s applicationId, map keys cannot carry ${…} references (the resolver templates values only), and the server derives this map from applicationId automatically. Excluded from state_fields (server-derived).
applicationIdstringOptionalOptional single-perspective scope. Carries the app-alert -> perspective DAG edge (the top-level scalar the graph can edge, unlike the applications map). Optional: the example may instead scope via the applications map.
boundaryScopestringRequiredTrace boundary scope the rule evaluates over.
evaluationTypestringRequiredGranularity at which the rule is evaluated.
granularityintegerRequiredEvaluation window in milliseconds.
tagFilterExpressionobjectRequiredTag-filter selector narrowing which calls the rule applies to. Server-normalized on read, so excluded from state_fields.
timeThresholdobjectRequiredApplicationTimeThreshold, how long/often the condition must hold to trigger. Server-normalized on read, so excluded from state_fields.
customPayloadFieldsarray<object>RequiredCustom key/value fields attached to triggered events (may be an empty array). Server-normalized on read, so excluded from state_fields.
ruleobjectOptionalSingle ApplicationAlertRule (throughput / errorRate / latency / …). Server-normalized on read, so excluded from state_fields.
rulesarray<object>OptionalMulti-rule variant (RuleWithThreshold entries). Server-normalized on read, so excluded from state_fields.
thresholdobjectOptionalStatic/adaptive threshold for the rule. Excluded from state_fields.
severityintegerOptionalEvent severity (server may default). Optional → excluded from state_fields. REQUIRED by the live API whenever rule+threshold are used (422 “threshold, rule and severity has to be defined when rules field is not provided”), the config-level required: false stays, since the multi-rules variant doesn’t need it.
gracePeriodintegerOptionalGrace period in ms before re-triggering. Optional → excluded from state_fields.
triggeringbooleanOptionalWhether the alert also opens an incident. Optional → excluded from state_fields.
includeInternalbooleanOptionalInclude internal calls in evaluation.
includeSyntheticbooleanOptionalInclude synthetic calls in evaluation.
Computed outputs: id. Depends on
  • alertChannelIds → instana_alerting_channel (required)
  • applicationId → instana_application_perspective (optional)

​
instana_application_perspective

An Instana application perspective is a saved, filter-defined view of an application’s traces and calls, the top-level unit Instana groups service monitoring, smart alerts, and SLOs around. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/application-monitoring/settings/application
ReadGET/api/application-monitoring/settings/application/{id}
ListGET/api/application-monitoring/settings/application
UpdatePUT/api/application-monitoring/settings/application/{id}
DeleteDELETE/api/application-monitoring/settings/application/{id}
Fields
FieldTypeRequiredDescription
labelstringRequiredApplication-perspective display name; Instana’s human identifier for the perspective (matched on during discovery).
boundaryScopestringRequiredTrace boundary scope for the perspective.
scopestringRequiredDownstream inclusion scope for the perspective.
tagFilterExpressionobjectOptionalTag-filter selector defining which calls belong to this perspective, the modern selector; never the deprecated matchSpecification. Writable on create; server-normalized on read, so excluded from state_fields to avoid phantom drift.
accessRulesarray<object>RequiredAccess rules controlling perspective visibility. Writable on create; server-enriched on read, so excluded from state_fields to avoid phantom drift.
Computed outputs: id. Consumers
  • instana_application_alert_config → .applicationId (optional)

​
instana_automation_action

An Instana automation action (Action) is a runnable script/HTTP/etc. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/automation/actions
ReadGET/api/automation/actions/{id}
ListGET/api/automation/actions
DeleteDELETE/api/automation/actions/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredAction display name; the identity discovery matches on.
typestringOptionalAction type (read-model; e.g. script/http). Optional -> excluded from state_fields.
descriptionstringOptionalFree-text action description (read-model).
Computed outputs: id.

​
instana_automation_policy

An Instana automation policy (Policy) binds a trigger (a customEvent / builtinEvent / smart-alert type, referencing an event spec by id) to one or more type configurations that run automation actions or workflows. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/automation/policies
ReadGET/api/automation/policies/{id}
ListGET/api/automation/policies
UpdatePUT/api/automation/policies/{id}
DeleteDELETE/api/automation/policies/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredPolicy display name; Instana’s human identifier (matched on during discovery).
descriptionstringOptionalFree-text policy description.
tagsarray<string>OptionalPolicy tags.
triggerobjectRequiredTrigger selector (type = customEvent / builtinEvent / *SmartAlert / schedule; id = the referenced event-spec id, a NESTED ref that makes no DAG edge, order with depends_on and resolve with ${…}). Server-normalized on read, so excluded from state_fields.
typeConfigurationsarray<object>RequiredTypeConfiguration entries (name = automatic/manual + a runnable that references an automation action or workflow by NESTED id, no DAG edge; resolve with ${…}). Server-normalized on read, so excluded from state_fields.
Computed outputs: id.

​
instana_builtin_event_spec

An Instana BUILT-IN event specification (BuiltInEventSpecification) is a shipped, catalog-defined event rule. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/event-specifications/built-in
ReadGET/api/events/settings/event-specifications/built-in/{id}
ListGET/api/events/settings/event-specifications/built-in
UpdatePOST/api/events/settings/event-specifications/built-in/{id}
DeleteDELETE/api/events/settings/event-specifications/built-in/{id}
Fields
FieldTypeRequiredDescription
idstringRequiredThe built-in event id (user-supplied; the adopt key + get_by_id id_source). Pick it from GET /api/events/settings/event-specifications/built-in.
enabledbooleanOptionalDesired enabled state (default true). The only writable field; converged via POST /{id}/enable | /{id}/disable by BuiltinEventSpecHandler.
namestringOptionalBuilt-in display name (read-model). Optional -> excluded from state_fields.
descriptionstringOptionalBuilt-in description (read-model). Optional -> excluded from state_fields.
severityintegerOptionalEvent severity (read-model). Optional -> excluded from state_fields.
triggeringbooleanOptionalWhether the event also opens an incident (read-model). Optional -> excluded from state_fields.

​
instana_custom_dashboard

An Instana custom dashboard (CustomDashboard) is a titled board of widgets with access rules. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/custom-dashboard
ReadGET/api/custom-dashboard/{id}
ListGET/api/custom-dashboard
UpdatePUT/api/custom-dashboard/{id}
DeleteDELETE/api/custom-dashboard/{id}
Fields
FieldTypeRequiredDescription
titlestringRequiredDashboard title; Instana’s human identifier (matched on during discovery).
accessRulesarray<object>RequiredAccessRule entries (accessType READ/READ_WRITE + relationType USER/API_TOKEN/ROLE/TEAM/GLOBAL). Server-normalized on read, so excluded from state_fields.
widgetsarray<object>RequiredWidget entries (id + type + config + layout). Excluded from state_fields: live-probed 2026-07-14, the backend’s PUT does not apply content edits to an existing widget id (see the resource description above) — comparing this field would report an Update that can never converge.
Computed outputs: id.

​
instana_custom_event_spec

An Instana custom event specification raises events (and optionally incidents, via triggering) when a rule over an entity type’s metrics matches, threshold breaches, entity verification, entity count, and the other AbstractRule variants. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/event-specifications/custom
ReadGET/api/events/settings/event-specifications/custom/{id}
ListGET/api/events/settings/event-specifications/custom
UpdatePUT/api/events/settings/event-specifications/custom/{id}
DeleteDELETE/api/events/settings/event-specifications/custom/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredEvent-specification display name; Instana’s human identifier for the spec (matched on during discovery).
entityTypestringRequiredPlugin/entity type the rules evaluate against (e.g. host, ibmMqQueue, ibmiActiveJobsInfo). Metric rules fire per entity of this type.
rulesarray<object>Required1-5 AbstractRule objects (discriminated by ruleType: threshold, system, entity_verification, entity_count, …). A threshold rule carries severity (5 warning / 10 critical), metricName (or metricPattern), aggregation, conditionOperator, conditionValue, and window (ms). Combined with ruleLogicalOperator when more than one.
descriptionstringOptionalFree-text description shown on the event.
querystringOptionalOptional Dynamic Focus query scoping which entities the rules are evaluated on (e.g. entity.ibmmq.queue.name:"CC.PAYMENTS.IN").
ruleLogicalOperatorstringOptionalHow multiple rules combine (AND / OR).
enabledbooleanOptionalWhether the specification is active (server default true).
triggeringbooleanOptionalWhether a matching event also raises an incident (server default false).
expirationTimeintegerOptionalGrace period in ms before an open event auto-closes; multiple of 1000 in [5000, 86400000]. Optional in the OpenAPI spec but REQUIRED by self-hosted 1.11.0 backends (a missing value 422s as “grace period … invalid”).
transientEventEnabledbooleanOptionalEmit transient events for short-lived violations (server default).
transientEventAlertMutedbooleanOptionalMute alerting on transient events (server default).
transientEventThresholdintegerOptionalThreshold (ms) below which a violation counts as transient (server default).
Computed outputs: id. Consumers
  • instana_alert → .eventFilteringConfiguration.ruleIds (optional)

​
instana_custom_payload_configuration

The Instana GLOBAL custom payload configuration (CustomPayloadConfiguration), a tenant-wide set of custom key/type fields attached to every triggered event. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/custom-payload-configurations
ReadGET/api/events/settings/custom-payload-configurations
DeleteDELETE/api/events/settings/custom-payload-configurations
Fields
FieldTypeRequiredDescription
fieldsarray<object>RequiredThe tenant-global custom payload fields (CustomPayloadField entries: required key + type, e.g. staticString / dynamic tag). PUT replaces the whole set. Server round-trips it with an added version; kept out of state_fields (see the Phase-3 probe note above).
Computed outputs: id.

​
instana_infra_alert_config

An Instana infrastructure smart alert (InfraAlertConfig) evaluates a rule (entityType + metricName + aggregation, narrowed by a tag filter) over infrastructure entities and routes triggered events to alerting channels. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/infra-alert-configs
ReadGET/api/events/settings/infra-alert-configs/{id}
ListGET/api/events/settings/infra-alert-configs
UpdatePOST/api/events/settings/infra-alert-configs/{id}
DeleteDELETE/api/events/settings/infra-alert-configs/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredSmart-alert display name; Instana’s human identifier (matched on during discovery).
descriptionstringRequiredAlert description shown on triggered events.
alertChannelIdsarray<string>OptionalIds of the alerting channels triggered events route to (optional in the infra-alert API). references on this array field produces a DAG edge; each ${instana_alerting_channel.<ref>.id} element resolves at apply.
granularityintegerRequiredEvaluation window in milliseconds.
groupByarray<string>RequiredMetric grouping keys (required by the InfraAlertConfig contract). Live content is confirmed in Phase 3; may be an empty array.
tagFilterExpressionobjectRequiredTag-filter selector narrowing which infrastructure entities the rule applies to. Server-normalized on read, so excluded from state_fields.
timeThresholdobjectRequiredInfraTimeThreshold, how long/often the condition must hold to trigger. Server-normalized on read, so excluded from state_fields.
customPayloadFieldsarray<object>RequiredCustom key/value fields attached to triggered events (may be an empty array). Server-normalized on read, so excluded from state_fields.
ruleobjectOptionalSingle InfraAlertRule (entityType + metricName + aggregation). Server-normalized on read, so excluded from state_fields.
rulesarray<object>OptionalMulti-rule variant. Server-normalized on read, so excluded from state_fields.
thresholdobjectOptionalStatic/adaptive threshold for the rule. Excluded from state_fields.
severityintegerOptionalEvent severity (server may default). Optional -> excluded from state_fields.
gracePeriodintegerOptionalGrace period in ms before re-triggering. Optional -> excluded from state_fields.
evaluationTypestringOptionalHow the rule is evaluated across entities. Optional -> excluded from state_fields.
triggeringbooleanOptionalWhether the alert also opens an incident. Optional -> excluded from state_fields.
Computed outputs: id. Depends on
  • alertChannelIds → instana_alerting_channel (optional)

​
instana_log_alert_config

An Instana log smart alert (LogAlertConfig) evaluates a rule over log events (narrowed by a tag filter) and routes triggered events to alerting channels. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/global-alert-configs/logs
ReadGET/api/events/settings/global-alert-configs/logs/{id}
ListGET/api/events/settings/global-alert-configs/logs
UpdatePOST/api/events/settings/global-alert-configs/logs/{id}
DeleteDELETE/api/events/settings/global-alert-configs/logs/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredSmart-alert display name; Instana’s human identifier (matched on during discovery).
descriptionstringRequiredAlert description shown on triggered events.
alertChannelIdsarray<string>OptionalIds of the alerting channels triggered events route to (optional in the log-alert API). references on this array field produces a DAG edge; each ${instana_alerting_channel.<ref>.id} element resolves at apply.
granularityintegerRequiredEvaluation window in milliseconds.
tagFilterExpressionobjectRequiredTag-filter selector narrowing which log events the rule applies to. Server-normalized on read, so excluded from state_fields.
timeThresholdobjectRequiredLogTimeThreshold, how long/often the condition must hold to trigger. Server-normalized on read, so excluded from state_fields.
groupByarray<string>OptionalMetric grouping keys (OPTIONAL for LogAlertConfig, unlike infra). May be an empty array. Excluded from state_fields.
customPayloadFieldsarray<object>OptionalCustom key/value fields attached to triggered events (OPTIONAL for LogAlertConfig, unlike infra; may be an empty array). Excluded from state_fields.
rulesarray<object>OptionalLogAlertRule entries (with thresholds). Server-normalized on read, so excluded from state_fields.
thresholdobjectOptionalStatic/adaptive threshold for the rule. Excluded from state_fields.
alertChannelsobjectOptionalLegacy severity->channel-ids map form. Optional -> excluded from state_fields.
severityintegerOptionalEvent severity (server may default). Optional -> excluded from state_fields.
gracePeriodintegerOptionalGrace period in ms before re-triggering. Optional -> excluded from state_fields.
Computed outputs: id. Depends on
  • alertChannelIds → instana_alerting_channel (optional)

​
instana_maintenance_window

An Instana maintenance window (MaintenanceConfigV2) suppresses alerting for the entities matched by its query during a scheduled window. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/settings/v2/maintenance/{id}
ReadGET/api/settings/v2/maintenance/{id}
ListGET/api/settings/v2/maintenance
UpdatePUT/api/settings/v2/maintenance/{id}
DeleteDELETE/api/settings/v2/maintenance/{id}
Fields
FieldTypeRequiredDescription
idstringRequiredCLIENT-SUPPLIED maintenance-window id. Required in the MaintenanceConfigV2 PUT body AND the get_by_id discovery id_source (delete.rs/update.rs substitute it into /{id}). Immutable, a different id is a different window.
namestringRequiredMaintenance-window display name.
querystringRequiredInstana entity query selecting the entities whose alerts are suppressed.
schedulingobjectRequiredMaintenanceConfigScheduling (start, duration, recurrence, …). Server-normalized on read (derives occurrence), so excluded from state_fields to avoid phantom Update{} drift.
pausedbooleanOptionalWhether the window is paused (server default). Optional → excluded from state_fields.
retriggerOpenAlertsEnabledbooleanOptionalRe-trigger open alerts when the window ends (server default). Optional → excluded from state_fields.
tagFilterExpressionobjectOptionalOptional tag-filter selector further narrowing the window’s scope. Server-normalized on read, so excluded from state_fields.
tagFilterExpressionEnabledbooleanOptionalWhether the tag-filter expression is applied (server default). Optional → excluded from state_fields.

​
instana_rbac_group

An Instana RBAC access group (ApiGroup) binds members to a permission set (ApiPermissionSet: a permissions string array plus optional scope filters). Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/settings/rbac/groups
ReadGET/api/settings/rbac/groups/{id}
ListGET/api/settings/rbac/groups
UpdatePUT/api/settings/rbac/groups/{id}
DeleteDELETE/api/settings/rbac/groups/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredGroup display name; Instana’s human identifier (matched on during discovery).
descriptionstringOptionalGroup description (the backend returns it on read; the writable scalar used for the K4 update round-trip). If the live round-trip proves it does not persist, narrow state_fields to [name] and cite K1-K3,K5 for this kind.
membersarray<object>RequiredApiMember entries (userId/email/name). Server-normalized on read (adds display name), so excluded from state_fields. May be an empty array; if the backend rejects empty members, supply a userId via ${env:} in the example.
permissionSetobjectRequiredApiPermissionSet (permissions string array + scope filters). Server- defaulted/normalized on read, so excluded from state_fields to avoid drift.
Computed outputs: id.

​
instana_rbac_team

An Instana RBAC team (ApiTeam) groups members under a scope for scoped access. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/settings/rbac/teams
ReadGET/api/settings/rbac/teams/{id}
ListGET/api/settings/rbac/teams
UpdatePUT/api/settings/rbac/teams/{id}
DeleteDELETE/api/settings/rbac/teams/{id}
Fields
FieldTypeRequiredDescription
tagstringRequiredTeam tag; Instana’s human identifier for a team (matched on during discovery, there is no name).
infoobjectOptionalApiTeamInfo ({description}). Small writable object; in state_fields so the K4 update round-trip can edit info.description. If it phantom-drifts on read, narrow state_fields to [tag] and cite K1-K3,K5 for this kind.
membersarray<object>OptionalApiTeamMember entries. Server-normalized on read, so excluded from state_fields.
scopeobjectOptionalApiTeamScope (access-permission + filter arrays). Server-normalized on read, so excluded from state_fields.
Computed outputs: id.

​
instana_release

An Instana release (Release) marks a deployment boundary on the timeline, optionally scoped to applications and services, so events and analytics can be correlated to a rollout. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/releases
ReadGET/api/releases/{id}
ListGET/api/releases
UpdatePUT/api/releases/{id}
DeleteDELETE/api/releases/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredRelease display name; Instana’s human identifier (matched on during discovery).
startintegerRequiredRelease start time in epoch milliseconds (required by the Release contract). Live-probed 2026-07-14: the backend rejects a start more than 10 minutes in the future (422 “Start must not be more than 10 minutes in the future”) — opposite of instana_maintenance_window’s “must not be in the past” rule. Any past epoch is accepted indefinitely, so committed examples use a fixed past timestamp (a release marks a deployment that already happened), not a future one.
applicationsarray<object>OptionalApplicationScope entries ({name}) the release is scoped to. Server- normalized on read (ApplicationScopeWithMetadata), so excluded from state_fields.
servicesarray<object>OptionalServiceScope entries ({name, scopedTo}) the release is scoped to. Server- normalized on read (ServiceScopeWithMetadata), so excluded from state_fields.
Computed outputs: id.

​
instana_slo_alert_config

An Instana SLO smart alert (ServiceLevelsAlertConfig) evaluates a rule (status / error-budget / burn-rate) over one or more SLO configs and routes triggered events to alerting channels. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/global-alert-configs/service-levels
ReadGET/api/events/settings/global-alert-configs/service-levels/{id}
ListGET/api/events/settings/global-alert-configs/service-levels
UpdatePOST/api/events/settings/global-alert-configs/service-levels/{id}
DeleteDELETE/api/events/settings/global-alert-configs/service-levels/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredSmart-alert display name; Instana’s human identifier (matched on during discovery).
descriptionstringRequiredAlert description shown on triggered events.
alertChannelIdsarray<string>RequiredIds of the alerting channels triggered events route to. references on this array field produces a DAG edge; each ${instana_alerting_channel.<ref>.id} element resolves at apply.
sloIdsarray<string>RequiredIds of the SLO configs this alert evaluates. references on this array field produces a DAG edge → SLO configs are ordered before this alert and each ${instana_slo_config.<ref>.id} element resolves at apply.
ruleobjectRequiredServiceLevelsAlertRule (status / error-budget / burn-rate). Server-normalized on read, so excluded from state_fields.
severityintegerRequiredEvent severity (required in the SLO-alert API; round-trips → in state_fields).
timeThresholdobjectRequiredServiceLevelsTimeThreshold, how long/often the condition must hold to trigger. Server-normalized on read, so excluded from state_fields.
customPayloadFieldsarray<object>RequiredCustom key/value fields attached to triggered events (may be an empty array). Server-normalized on read, so excluded from state_fields.
thresholdobjectOptionalStaticThreshold for the rule. Server-normalized on read, so excluded from state_fields.
burnRateConfigarray<object>OptionalBurn-rate window configs. Server-normalized on read, so excluded from state_fields.
burnRateTimeWindowsobjectOptionalBurn-rate time windows. Server-normalized on read, so excluded from state_fields.
triggeringbooleanOptionalWhether the alert also opens an incident. Optional → excluded from state_fields.
Computed outputs: id. Depends on
  • alertChannelIds → instana_alerting_channel (required)
  • sloIds → instana_slo_config (required)

​
instana_slo_config

An Instana SLO config (SLOConfigWithRBACTag) defines a service-level objective: a target attainment over a time window for a chosen entity and indicator. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/settings/slo
ReadGET/api/settings/slo/{id}
ListGET/api/settings/slo
UpdatePUT/api/settings/slo/{id}
DeleteDELETE/api/settings/slo/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredSLO display name; Instana’s human identifier (matched on during discovery).
targetfloatRequiredSLO target attainment (fraction, e.g. 0.99).
tagsarray<string>RequiredSLO tags.
entityobjectRequiredSloEntity selector (application/service/endpoint scope). The application id is nested here, so it makes no DAG edge, order with depends_on and resolve the value with ${…} interpolation. Server-normalized on read, so excluded from state_fields to avoid phantom drift.
indicatorobjectRequiredServiceLevelIndicator (availability / latency / custom). Server-normalized on read, so excluded from state_fields to avoid phantom drift.
timeWindowobjectRequiredRolling or fixed evaluation window. Server-normalized on read, so excluded from state_fields to avoid phantom drift.
Computed outputs: id. Consumers
  • instana_slo_alert_config → .sloIds (required)

​
instana_synthetic_alert_config

An Instana synthetic smart alert (SyntheticAlertConfig) evaluates a rule over one or more synthetic tests’ results and routes triggered events to alerting channels. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/global-alert-configs/synthetics
ReadGET/api/events/settings/global-alert-configs/synthetics/{id}
ListGET/api/events/settings/global-alert-configs/synthetics
UpdatePOST/api/events/settings/global-alert-configs/synthetics/{id}
DeleteDELETE/api/events/settings/global-alert-configs/synthetics/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredSmart-alert display name; Instana’s human identifier (matched on during discovery).
descriptionstringRequiredAlert description shown on triggered events.
alertChannelIdsarray<string>RequiredIds of the alerting channels triggered events route to. references on this array field produces a DAG edge; each ${instana_alerting_channel.<ref>.id} element resolves at apply.
syntheticTestIdsarray<string>RequiredIds of the synthetic tests this alert evaluates. references on this array field produces a DAG edge → tests are ordered before this alert and each ${instana_synthetic_test.<ref>.id} element resolves at apply.
ruleobjectRequiredSyntheticAlertRule (e.g. failure rate). Server-normalized on read, so excluded from state_fields.
tagFilterExpressionobjectRequiredTag-filter selector narrowing which test runs the rule applies to. Server-normalized on read, so excluded from state_fields.
timeThresholdobjectRequiredSyntheticTimeThreshold, how long/often the condition must hold to trigger. Server-normalized on read, so excluded from state_fields.
customPayloadFieldsarray<object>RequiredCustom key/value fields attached to triggered events (may be an empty array). Server-normalized on read, so excluded from state_fields.
severityintegerOptionalEvent severity (server may default). Optional → excluded from state_fields.
gracePeriodintegerOptionalGrace period in ms before re-triggering. Optional → excluded from state_fields.
Computed outputs: id. Depends on
  • alertChannelIds → instana_alerting_channel (required)
  • syntheticTestIds → instana_synthetic_test (required)

​
instana_synthetic_test

An Instana synthetic test (SyntheticTest) runs a scripted or HTTP probe from one or more PoP locations on a schedule. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/synthetics/settings/tests
ReadGET/api/synthetics/settings/tests/{id}
ListGET/api/synthetics/settings/tests
UpdatePUT/api/synthetics/settings/tests/{id}
DeleteDELETE/api/synthetics/settings/tests/{id}
Fields
FieldTypeRequiredDescription
labelstringRequiredSynthetic-test display name; Instana’s human identifier (matched on during discovery).
activebooleanRequiredWhether the test is enabled.
testFrequencyintegerRequiredRun frequency in minutes.
locationsarray<string>RequiredPoP location ids the test runs from. Server-normalized on read, so excluded from state_fields to avoid phantom drift. On self-hosted Standard Edition a deployed PoP id is required (Phase 5 prerequisite).
configurationobjectRequiredSyntheticTypeConfiguration, e.g. {syntheticType: HTTPAction, url, …}. Server-normalized on read, so excluded from state_fields to avoid phantom drift.
descriptionstringOptionalFree-text description.
applicationIdstringOptionalApplication perspective to associate results with.
playbackModestringOptionalHow multi-location runs are scheduled.
customPropertiesobjectOptionalUser-defined key/value metadata. Server-normalized on read, so excluded from state_fields to avoid phantom drift.
Computed outputs: id. Consumers
  • instana_synthetic_alert_config → .syntheticTestIds (required)

​
instana_website_alert_config

An Instana website smart alert (WebsiteAlertConfig) evaluates a rule over an end-user-monitored website’s beacons and routes triggered events to alerting channels. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/events/settings/website-alert-configs
ReadGET/api/events/settings/website-alert-configs/{id}
ListGET/api/events/settings/website-alert-configs
UpdatePOST/api/events/settings/website-alert-configs/{id}
DeleteDELETE/api/events/settings/website-alert-configs/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredSmart-alert display name; Instana’s human identifier (matched on during discovery).
descriptionstringRequiredAlert description shown on triggered events.
websiteIdstringRequiredId of the website (EUM config) this alert scopes to. references produces the website -> website-alert DAG edge; the Phase 5 example resolves it with ${instana_website_config.<ref>.id} interpolation.
alertChannelIdsarray<string>OptionalIds of the alerting channels triggered events route to (optional in the website-alert API). references on this array field produces a DAG edge; each ${instana_alerting_channel.<ref>.id} element resolves at apply.
granularityintegerRequiredEvaluation window in milliseconds.
tagFilterExpressionobjectRequiredTag-filter selector narrowing which beacons the rule applies to. Server-normalized on read, so excluded from state_fields.
timeThresholdobjectRequiredWebsiteTimeThreshold, how long/often the condition must hold to trigger. Server-normalized on read, so excluded from state_fields.
customPayloadFieldsarray<object>RequiredCustom key/value fields attached to triggered events (may be an empty array). Server-normalized on read, so excluded from state_fields.
ruleobjectOptionalSingle WebsiteAlertRule. Server-normalized on read, so excluded from state_fields.
rulesarray<object>OptionalMulti-rule variant. Server-normalized on read, so excluded from state_fields.
thresholdobjectOptionalStatic/adaptive threshold for the rule. Excluded from state_fields.
severityintegerOptionalEvent severity (server may default). Optional → excluded from state_fields.
gracePeriodintegerOptionalGrace period in ms before re-triggering. Optional → excluded from state_fields.
triggeringbooleanOptionalWhether the alert also opens an incident. Optional → excluded from state_fields.
Computed outputs: id. Depends on
  • websiteId → instana_website_config (required)
  • alertChannelIds → instana_alerting_channel (optional)

​
instana_website_config

An Instana website (End-User Monitoring config) is the top-level unit Instana groups browser/EUM beacons and website smart alerts around. Runs on SaaS + Software · ID field id Endpoints
OperationMethodPath
CreatePOST/api/website-monitoring/config
ReadGET/api/website-monitoring/config/{id}
ListGET/api/website-monitoring/config
UpdatePUT/api/website-monitoring/config/{id}
DeleteDELETE/api/website-monitoring/config/{id}
Fields
FieldTypeRequiredDescription
namestringRequiredWebsite display name; Instana’s human identifier (matched on during discovery) and the value WebsiteConfigHandler passes as the ?name= query param on create.
Computed outputs: id, appName. Consumers
  • instana_website_alert_config → .websiteId (required)