Dynatrace is an observability platform that monitors applications, infrastructure, and user experience from a single agent. Its Davis AI correlates signals across the stack into problems — a single incident with a root cause, an impact assessment, and the affected entities attached — instead of a stream of disconnected alerts.
What you can reach from Sim
Problems — list and inspect Davis problems, read their root cause and affected entities, close them, and manage their comments.
Metrics — query time series with a metric selector, discover which metrics exist, read a metric's descriptor, and push your own data points.
Entities — list and inspect monitored hosts, services, applications, and Kubernetes workloads, and enumerate the entity types available for building selectors.
Tags — read, add, and remove the custom tags that drive selectors, management zones, and alerting.
Events — read deployments, availability changes, and annotations, and ingest your own.
Logs — search log records and ingest new ones.
SLOs — read, create, update, and delete service-level objectives, with their attainment, error budget, and burn rate.
Application Security — list and inspect vulnerabilities with risk assessment and remediation guidance, walk their remediation items, mute and unmute them singly or in bulk, and review the runtime attacks that exploited them.
Settings — browse schemas and read, create, update, and delete settings objects. This is how maintenance windows, alerting profiles, management zones, and anomaly-detection thresholds are configured.
Synthetic — list monitors, trigger an on-demand batch execution, and poll the batch for its result.
Audit log — read who changed which configuration, and when.
Setup
You need two values: your environment URL and an access token .
The environment URL is the base address of your Dynatrace environment, without the API path:
Deployment Environment URL SaaS https://abc12345.live.dynatrace.comManaged / environment ActiveGate https://your-activegate:9999/e/abc12345
Create the token under Access tokens in Dynatrace, and grant only the scopes for the operations you plan to call. Each action's apiToken description names the scope it needs:
Area Read Write Problems problems.readproblems.writeMetrics metrics.readmetrics.ingestEntities and tags entities.readentities.writeEvents events.readevents.ingestLogs logs.readlogs.ingestSLOs slo.readslo.writeVulnerabilities securityProblems.readsecurityProblems.writeAttacks attacks.read— Settings settings.readsettings.writeSynthetic syntheticExecutions.read, ReadSyntheticDatasyntheticExecutions.writeAudit log auditLogs.read—
Note that Synthetic monitors are the one part of this integration on Environment API v1 — Sim handles the path difference, but the token scopes differ from the v2 endpoints.
Selectors
Most read operations are scoped by a selector rather than by fixed filter fields. Criteria are comma-separated, and every criterion matched must hold:
entitySelector: type("HOST"),tag("env:prod")
problemSelector: status("open"),severityLevel("AVAILABILITY")
metricSelector: builtin:host.cpu.usage:splitBy("dt.entity.host"):avg:names
securityProblemSelector: status("OPEN"),riskLevel("CRITICAL")
Every selector field in the block has a wand — describe what you want in plain language and Sim writes the selector for you.
Settings objects
Most Dynatrace configuration is a settings object : a JSON value whose shape is defined by a schema such as builtin:alerting.maintenance-window. There is no fixed structure Sim can validate for you, so the reliable way to write one is to read an existing object of the same schema first and mirror its value. Get Settings Object also returns an updateToken — pass it back on update or delete and the call fails rather than overwriting a change someone else made in the meantime.
Pagination
List operations return a nextPageKey (a nextSliceKey for log search). Feed it back into the next call to read the following page. Dynatrace encodes the original filters into the cursor, so Sim sends the cursor alone and ignores the other filters on that call — which is what the API requires.
Integrate Dynatrace into workflows. Investigate and close Davis problems, query metrics and monitored entities, search and ingest logs, push deployment events, manage SLOs and their burn rates, triage and mute Application Security vulnerabilities, review runtime attacks, tag entities, manage settings objects such as maintenance windows and alerting profiles, run synthetic monitors on demand, and read the audit log.
List Davis-detected problems in a Dynatrace environment, filtered by timeframe, problem selector, or entity selector.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the problems.read scope fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-1d. Defaults to now-2h tostring No End of the timeframe in the same formats as From. Defaults to now problemSelectorstring No Problem selector, e.g. status("open"),severityLevel("AVAILABILITY"),impactLevel("SERVICES") entitySelectorstring No Entity selector scoping the result, e.g. type("HOST"),tag("env:prod") sortstring No Sort order: status, startTime, or relevance, each optionally prefixed with + or - (e.g. -startTime) fieldsstring No Comma-separated optional properties to include: evidenceDetails, impactAnalysis, recentComments pageSizenumber No Problems per page (max 500, default 50) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description problemsarray Matching problems
Get the full details of a single Dynatrace problem, including root cause, affected entities, and optionally its evidence and impact analysis.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the problems.read scope problemIdstring Yes ID of the problem (e.g., -1234567890123456789_1700000000000V2) fieldsstring No Comma-separated optional properties to include. Defaults to all of them: evidenceDetails, impactAnalysis, recentComments
Parameter Type Description problemobject The requested problem
Close a Dynatrace problem and record the closing comment.
Parameter Type Description problemIdstring ID of the closed problem closeTimestampnumber Timestamp when closing was triggered, in UTC milliseconds closingboolean Whether the problem is in the process of being closed commentobject The closing comment that was recorded
List the comments recorded on a Dynatrace problem.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the problems.read scope problemIdstring Yes ID of the problem whose comments should be listed pageSizenumber No Comments per page (max 500, default 10) nextPageKeystring No Cursor for the next page. Page size is ignored when it is set
Parameter Type Description commentsarray Comments on the problem
Add a comment to a Dynatrace problem.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the problems.write scope problemIdstring Yes ID of the problem to comment on messagestring Yes Text of the comment contextstring No Context of the comment, shown alongside the author (e.g., the source system)
Parameter Type Description problemIdstring ID of the problem the comment was added to messagestring Text of the comment that was added contextstring Context of the comment
Read metric data points from Dynatrace using a metric selector, with optional entity and management-zone scoping.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the metrics.read scope metricSelectorstring Yes Metric selector, up to 10 metrics comma-separated, with optional transformations after a colon (e.g. builtin:host.cpu.usage:avg:names) fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-2h. Defaults to now-2h tostring No End of the timeframe in the same formats as From. Defaults to now resolutionstring No Number of data points (default 120), a timespan such as 10m or 3w, or Inf for a single aggregated value entitySelectorstring No Entity selector scoping the query, e.g. type("HOST"),tag("env:prod") mzSelectorstring No Management zone selector, e.g. mzName("Production")
Parameter Type Description resultarray One entry per queried metric ↳ metricId string Metric key including transformations ↳ dataPointCountRatio number Queried data points relative to the query limit ↳ dimensionCountRatio number Queried dimension tuples relative to the query limit ↳ appliedOptionalFilters array Optional filters Dynatrace applied to the query ↳ dql json DQL translation of the query, when available ↳ status string Whether the translation succeeded ↳ query string The equivalent DQL query ↳ warnings array Warnings for this metric ↳ data array Series of the metric, one per dimension tuple ↳ dimensions array Dimension values of the series ↳ dimensionMap json Dimension values keyed by dimension key ↳ timestamps array Timestamps in UTC milliseconds, one per value ↳ values array Metric values. Null where no data exists resolutionstring Resolution Dynatrace actually used
Discover the metrics available in a Dynatrace environment, filtered by metric selector, free text, or metadata.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the metrics.read scope metricSelectorstring No Metric selector, supporting wildcards (e.g. builtin:host.cpu.*) textstring No Free-text search across metric display names and descriptions fieldsstring No Comma-separated descriptor properties. Prefix with + to add a non-default property and - to drop a default one; metricId is always returned (e.g. +aggregationTypes,-description) writtenSincestring No Only metrics written since this point, as UTC milliseconds, ISO 8601, or a relative expression such as now-7d writtenSinceModestring No INCLUDE (default) keeps metrics written since Written Since; EXCLUDE keeps the ones not written since then metadataSelectorstring No Metadata selector, e.g. unit("Percent"),tags("dashboard") pageSizenumber No Metrics per page (max 500, default 100) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description metricsarray Matching metric descriptors
Get the descriptor of a single Dynatrace metric — its unit, dimensions, supported aggregations, and transformations.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the metrics.read scope metricKeystring Yes Metric key, optionally followed by transformation operators separated by a colon (e.g. builtin:host.cpu.usage)
Parameter Type Description metricobject The requested metric descriptor
Push custom metric data points into Dynatrace using the metric line protocol, one data point per line.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the metrics.ingest scope payloadstring Yes Metric line protocol payload, one data point per line, max 1 MB (e.g. cpu.temperature,dt.entity.host=HOST-06F288EE2A930951,cpu=1 55)
Parameter Type Description linesOknumber Number of accepted data points linesInvalidnumber Number of rejected data points ingestErrorjson Details of the invalid lines ↳ code number Error code ↳ message string Error message ↳ invalidLines array The rejected lines ↳ line number Line number in the payload ↳ error string Why the line was rejected warningsjson Warnings raised during ingestion, such as changed metric keys ↳ message string Warning message ↳ changedMetricKeys array Lines whose metric key Dynatrace rewrote ↳ line number Line number in the payload ↳ warning string What was changed
List monitored entities — hosts, services, applications, Kubernetes workloads — matching an entity selector.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the entities.read scope entitySelectorstring Yes Entity selector defining the scope, e.g. type("HOST"),tag("env:prod") or entityId("HOST-06F288EE2A930951") fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-3d. Defaults to now-3d tostring No End of the timeframe in the same formats as From. Defaults to now fieldsstring No Comma-separated additional entity properties to include (e.g. +lastSeenTms,+properties.BITNESS,+tags) sortstring No Sort by display name: +displayName ascending or -displayName descending pageSizenumber No Entities per page (default 50) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description entitiesarray Matching monitored entities
Get the properties, tags, management zones, and relationships of a single monitored entity.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the entities.read scope entityIdstring Yes ID of the entity (e.g., HOST-06F288EE2A930951) fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-3d. Defaults to now-3d tostring No End of the timeframe in the same formats as From. Defaults to now fieldsstring No Comma-separated additional entity properties to include (e.g. +lastSeenTms,+properties.BITNESS)
Parameter Type Description entityobject The requested monitored entity
List the monitored entity types available in the environment, with the properties and relationships each supports. Use it to build valid entity selectors.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the entities.read scope pageSizenumber No Entity types per page (max 500, default 50) nextPageKeystring No Cursor for the next page. Page size is ignored when it is set
Parameter Type Description typesarray Available entity types ↳ type string Entity type (e.g., HOST, SERVICE) ↳ displayName string Display name of the type ↳ dimensionKey string Metric dimension key of the type ↳ entityLimitExceeded boolean Whether the environment exceeded the entity limit for this type ↳ fromRelationships array Relationships originating at this type ↳ id string Relationship ID ↳ toTypes array Entity types the relationship points to ↳ toRelationships array Relationships pointing at this type ↳ id string Relationship ID ↳ fromTypes array Entity types the relationship originates from
List events — deployments, availability changes, alerts, custom annotations — in a Dynatrace environment.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the events.read scope fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-1d. Defaults to now-2h tostring No End of the timeframe in the same formats as From. Defaults to now eventSelectorstring No Event selector, e.g. eventType("CUSTOM_DEPLOYMENT"),status("OPEN"),correlationId("build-42") entitySelectorstring No Entity selector scoping the result, e.g. type("SERVICE"),tag("env:prod") pageSizenumber No Events per page (max 1000, default 100) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description eventsarray Matching events
Get the full details of a single Dynatrace event.
Parameter Type Description eventobject The requested event
Push an event into Dynatrace — a deployment marker, custom annotation, or custom alert — attached to the entities matched by an entity selector.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the events.ingest scope eventTypestring Yes One of AVAILABILITY_EVENT, CUSTOM_ALERT, CUSTOM_ANNOTATION, CUSTOM_CONFIGURATION, CUSTOM_DEPLOYMENT, CUSTOM_INFO, ERROR_EVENT, MARKED_FOR_TERMINATION, PERFORMANCE_EVENT, RESOURCE_CONTENTION_EVENT, WARNING titlestring Yes Title of the event entitySelectorstring No Entity selector for the entities to attach the event to. Defaults to the environment entity startTimenumber No Event start in UTC milliseconds. Defaults to now endTimenumber No Event end in UTC milliseconds. Defaults to the start time plus the timeout eventTimeoutnumber No Minutes the event stays open when no end time is given. Defaults to 15, capped at 360 propertiesjson No Event properties as a key-value object. Max 100 entries, keys up to 100 and values up to 4096 characters
Parameter Type Description reportCountnumber Number of events Dynatrace reported eventIngestResultsarray One result per ingested event ↳ correlationId string Correlation ID of the ingested event ↳ status string OK, INVALID_ENTITY_TYPE, INVALID_METADATA, or INVALID_TIMESTAMPS
Search log records in Dynatrace by query and timeframe, for troubleshooting and incident analysis.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the logs.read scope, or storage:logs:read and storage:buckets:read on Grail querystring No Log search query, e.g. status="ERROR" AND dt.entity.host="HOST-06F288EE2A930951" fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-1h. Defaults to now-2w tostring No End of the timeframe in the same formats as From. Defaults to now sortstring No Sort by field with a + or - prefix, e.g. -timestamp for newest first limitnumber No Number of log records to return (max 1000, default 1000) nextSliceKeystring No Cursor for the next slice. All other filters are ignored when it is set
Parameter Type Description resultsarray Matching log records ↳ timestamp number Log timestamp in UTC milliseconds ↳ status string Log level: ERROR, WARN, INFO, NONE, or NOT_APPLICABLE ↳ content string Log message content ↳ eventType string Event type of the record ↳ additionalColumns json Additional log attributes keyed by column name sliceSizenumber Number of records in this slice nextSliceKeystring Cursor for the next slice. Null when the result is complete warningsstring Warning raised while searching
Push log events into Dynatrace. Accepts a single log event object or an array of them.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the logs.ingest scope logsjson Yes A log event object, or an array of them. Recognized keys are content, timestamp, and severity; any other key becomes a custom attribute (e.g. [{"content":"Deploy finished","severity":"info","service":"checkout"}])
Parameter Type Description acceptedboolean True when Dynatrace accepted every log event (HTTP 204) statusCodenumber HTTP status Dynatrace returned. 204 is full success, 200 is partial success detailsjson Partial-success body, present only when some events were rejected. The reference does not document its shape, so it is passed through as-is
List service-level objectives with their current attainment, error budget, and burn rate.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the slo.read scope sloSelectorstring No SLO selector, e.g. healthState("WARNING"),text("checkout"),problems("true"). Combine criteria with commas fromstring No Start of the evaluation timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-7d tostring No End of the evaluation timeframe in the same formats as From. Defaults to now timeFramestring No CURRENT evaluates each SLO over its own timeframe; GTF evaluates over the From/To range sortstring No Sort by name: name ascending or -name descending enabledSlosstring No Filter by enabled state: true, false, or all evaluateboolean No Evaluate each SLO and include its calculated values showGlobalSlosboolean No Include SLOs that are not scoped to a management zone pageSizenumber No SLOs per page (max 10000, default 10) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description slosarray Matching service-level objectives
Get a single service-level objective with its evaluated attainment, error budget, and burn rate.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the slo.read scope sloIdstring Yes ID of the SLO fromstring No Start of the evaluation timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-7d. Defaults to now-2w tostring No End of the evaluation timeframe in the same formats as From. Defaults to now timeFramestring No CURRENT evaluates the SLO over its own timeframe; GTF evaluates over the From/To range
Parameter Type Description sloobject The requested service-level objective
List vulnerabilities detected by Dynatrace Application Security, filtered by risk level, status, CVE, or technology.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the securityProblems.read scope securityProblemSelectorstring No Security problem selector, e.g. status("OPEN"),riskLevel("CRITICAL"),technology("JAVA") fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-7d. Defaults to now-30d tostring No End of the timeframe in the same formats as From. Defaults to now fieldsstring No Comma-separated optional properties to include: +riskAssessment, +managementZones, +codeLevelVulnerabilityDetails, +globalCounts sortstring No Sort by a field with a + or - prefix, e.g. -riskAssessment.riskScore pageSizenumber No Security problems per page (max 500, default 100) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description securityProblemsarray Matching security problems
Get a single vulnerability with its description, remediation guidance, affected entities, and risk assessment.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the securityProblems.read scope securityProblemIdstring Yes ID of the security problem fieldsstring No Comma-separated optional properties to include, each prefixed with +. Defaults to every detail property: +riskAssessment, +managementZones, +codeLevelVulnerabilityDetails, +globalCounts, +filteredCounts, +description, +remediationDescription, +events, +vulnerableComponents, +affectedEntities, +exposedEntities, +reachableDataAssets, +relatedEntities, +relatedContainerImages, +relatedAttacks, +entryPoints managementZoneFilterstring No Restrict the counts to management zones, e.g. names("Production") fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-24h. Defaults to the last 24 hours
Parameter Type Description securityProblemobject The requested security problem
Read the Dynatrace audit log — who changed which configuration, when, and whether it succeeded.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the auditLogs.read scope filterstring No Audit log filter, e.g. eventType("UPDATE"),user("someone@example.com "),category("CONFIG") fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-1d. Defaults to now-2w tostring No End of the timeframe in the same formats as From. Defaults to now sortstring No timestamp for oldest first, or -timestamp for newest first (default) pageSizenumber No Entries per page (max 5000, default 1000) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description auditLogsarray Matching audit log entries ↳ logId string Audit log entry ID ↳ eventType string Type of the audited change ↳ category string Category of the audited change ↳ entityId string ID of the changed entity ↳ environmentId string Environment the change happened in ↳ user string User or token that made the change ↳ userType string Type of the acting user ↳ userOrigin string Origin of the request ↳ timestamp number Change timestamp in UTC milliseconds ↳ success boolean Whether the change succeeded ↳ message string Description of the change ↳ patch json JSON patch describing the change. Its shape follows whatever settings object was edited, so it is dynamic ↳ settingsSchemaId string Settings schema ID (dt.settings.schema_id) ↳ settingsScopeId string Settings scope ID (dt.settings.scope_id) ↳ settingsKey string Settings key (dt.settings.key) ↳ settingsObjectId string Settings object ID (dt.settings.object_id) ↳ settingsObjectSummary string Settings object summary (dt.settings.object_summary) ↳ settingsScopeName string Settings scope name (dt.settings.scope_name)
Mute a single Dynatrace vulnerability with a reason, for triaging false positives or accepted risk.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the securityProblems.write scope securityProblemIdstring Yes ID of the security problem to mute reasonstring Yes One of CONFIGURATION_NOT_AFFECTED, FALSE_POSITIVE, IGNORE, OTHER, VULNERABLE_CODE_NOT_IN_USE commentstring No Explanation recorded alongside the mute
Parameter Type Description securityProblemIdstring ID of the muted security problem reasonstring Reason recorded for the mute commentstring Comment recorded for the mute alreadyInStateboolean True when Dynatrace reported the problem was already muted (HTTP 204)
Unmute a single Dynatrace vulnerability, returning it to the active triage queue.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the securityProblems.write scope securityProblemIdstring Yes ID of the security problem to unmute reasonstring Yes Reason for unmuting. AFFECTED is the only value the API accepts commentstring No Explanation recorded alongside the unmute
Parameter Type Description securityProblemIdstring ID of the unmuted security problem reasonstring Reason recorded for the unmute commentstring Comment recorded for the unmute alreadyInStateboolean True when Dynatrace reported the problem was already unmuted (HTTP 204)
Mute several Dynatrace vulnerabilities at once with a shared reason, for bulk triage.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the securityProblems.write scope securityProblemIdsstring Yes Security problem IDs to mute, comma-separated or as a JSON array reasonstring Yes One of CONFIGURATION_NOT_AFFECTED, FALSE_POSITIVE, IGNORE, OTHER, VULNERABLE_CODE_NOT_IN_USE commentstring No Explanation recorded against every muted problem
Parameter Type Description changedCountnumber How many problems actually changed state, excluding those already muted
Unmute several Dynatrace vulnerabilities at once, returning them to active triage.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the securityProblems.write scope securityProblemIdsstring Yes Security problem IDs to unmute, comma-separated or as a JSON array reasonstring Yes Reason for unmuting. AFFECTED is the only value the API accepts commentstring No Explanation recorded against every unmuted problem
Parameter Type Description changedCountnumber How many problems actually changed state, excluding those already unmuted
List the remediation items of a third-party vulnerability — the components to upgrade, their affected entities, and their mute state.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the securityProblems.read scope securityProblemIdstring Yes ID of the third-party security problem remediationItemSelectorstring No Remediation item selector, e.g. vulnerabilityState("VULNERABLE"),muted("false"),exposure("PUBLIC_NETWORK")
Parameter Type Description remediationItemsarray Remediation items of the vulnerability. This endpoint returns no total count
List runtime attacks Dynatrace Application Protection detected — injection attempts, their source, and whether they were blocked.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the attacks.read scope attackSelectorstring No Attack selector, e.g. state("EXPLOITED"),attackType("SQL_INJECTION"),technology("JAVA") fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression such as now-7d. Defaults to now-30d tostring No End of the timeframe in the same formats as From. Defaults to now fieldsstring No Comma-separated optional properties to include: +attackTarget, +request, +entrypoint, +vulnerability, +securityProblem, +attacker, +managementZones, +affectedEntities sortstring No Sort by displayId, displayName, attackType, state, sourceIp, requestPath, or timestamp with a + or - prefix pageSizenumber No Attacks per page (max 500, default 100) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description attacksarray Matching attacks
Get a single attack with its entry point, payload, attacker, and the vulnerability it exploited.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the attacks.read scope attackIdstring Yes ID of the attack fieldsstring No Comma-separated optional properties to include, each prefixed with +. Defaults to all of them: +attackTarget, +request, +entrypoint, +vulnerability, +securityProblem, +attacker, +managementZones
Parameter Type Description attackobject The requested attack
List the custom tags applied to the monitored entities an entity selector matches.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the entities.read scope entitySelectorstring Yes Entity selector for the entities to read tags from, e.g. type("HOST") fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression. Defaults to now-24h tostring No End of the timeframe in the same formats as From. Defaults to now
Parameter Type Description tagsarray Custom tags on the matched entities
Add custom tags to every monitored entity an entity selector matches. Tags drive selectors, management zones, and alerting.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the entities.write scope entitySelectorstring Yes Entity selector for the entities to tag, e.g. type("HOST"),tag("env:staging") tagsjson Yes Tags to add, as an array of objects with a key and an optional value (e.g. [{"key":"owner","value":"platform"},{"key":"reviewed"}]) fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression. Defaults to now-24h tostring No End of the timeframe in the same formats as From. Defaults to now
Parameter Type Description appliedTagsarray Tags that were applied matchedEntitiesCountnumber How many entities the selector matched and were tagged
Remove a custom tag from every monitored entity an entity selector matches. Deletes one key-value pair, or every tag with the key.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the entities.write scope entitySelectorstring Yes Entity selector for the entities to untag, e.g. type("HOST"),tag("owner:old") keystring Yes Key of the tag to delete valuestring No Value of the tag to delete. Omit it and set Delete All With Key to remove every value of the key deleteAllWithKeyboolean No Delete every tag carrying the key, regardless of value fromstring No Start of the timeframe as UTC milliseconds, ISO 8601, or a relative expression. Defaults to now-24h tostring No End of the timeframe in the same formats as From. Defaults to now
Parameter Type Description matchedEntitiesCountnumber How many entities the selector matched and had the tag removed from
List the settings schemas available in the environment. Use it to find the schema ID for a configuration type such as builtin:alerting.profile.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the settings.read scope fieldsstring No Comma-separated fields to include: schemaId, displayName, maturity, latestSchemaVersion, multiObject, ordered, ownerBasedAccessControl
Parameter Type Description schemasarray Available settings schemas
List settings objects — the configuration behind maintenance windows, alerting profiles, management zones, and anomaly detection.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the settings.read scope schemaIdsstring No Comma-separated schema IDs, e.g. builtin:alerting.profile scopesstring No Comma-separated scopes, e.g. environment or HOST-06F288EE2A930951 externalIdsstring No Comma-separated external IDs fieldsstring No Comma-separated fields to include: objectId, value, schemaId, schemaVersion, scope, author, modified, updateToken, created, externalId, summary, searchSummary filterstring No Filter expression over created, modified, createdBy, modifiedBy, or value sortstring No Sort expression, e.g. -modified pageSizenumber No Objects per page (max 500, default 100) nextPageKeystring No Cursor for the next page. All other filters are ignored when it is set
Parameter Type Description itemsarray Matching settings objects
Get a single settings object with its value and its update token. Read it before updating so the token can guard against a concurrent change.
Parameter Type Description objectobject The requested settings object
Create a settings object — a maintenance window, alerting profile, management zone, or any other schema-backed configuration.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the settings.write scope schemaIdstring Yes Schema of the object to create, e.g. builtin:alerting.maintenance-window. List Settings Schemas returns the available IDs scopestring Yes Scope the object applies to, e.g. environment or an entity ID such as HOST-06F288EE2A930951 valuejson Yes The configuration itself. Its shape is defined by the schema — read an existing object of the same schema to see the expected fields schemaVersionstring No Schema version to validate against. Defaults to the latest externalIdstring No External ID to correlate the object with a system outside Dynatrace validateOnlyboolean No Validate the payload without creating anything
Parameter Type Description resultsarray One result per submitted object ↳ code number Per-object HTTP status ↳ objectId string ID of the created object ↳ writeError json Validation error for this object, when it failed ↳ code number Error code ↳ message string Error message ↳ constraintViolations array Which part of the value failed validation ↳ location string Where the violation was found ↳ message string What is wrong ↳ parameterLocation string HEADER, PATH, PAYLOAD_BODY, or QUERY ↳ path string Path to the offending field ↳ invalidValue json The value that was rejected. Mirrors the submitted schema-defined value, so the shape is dynamic objectIdstring ID of the created object, lifted from the first result
Update an existing settings object. Pass the update token from Get Settings Object to fail rather than overwrite a concurrent change.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the settings.write scope objectIdstring Yes ID of the settings object to update valuejson Yes The full replacement configuration. Its shape is defined by the object schema — this replaces the value rather than merging into it schemaVersionstring No Schema version to validate against updateTokenstring No Token from Get Settings Object. When set, the update fails if the object changed in the meantime. Omit it to overwrite unconditionally validateOnlyboolean No Validate the payload without saving anything
Parameter Type Description objectIdstring ID of the updated object codenumber Status Dynatrace reported for the update
Delete a settings object. Dynatrace cannot undo this.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the settings.write scope objectIdstring Yes ID of the settings object to delete updateTokenstring No Token from Get Settings Object. When set, the delete fails if the object changed in the meantime
Parameter Type Description objectIdstring ID of the deleted settings object deletedboolean Always true — a failed delete raises instead
List synthetic monitors and their IDs. Use it to find the monitor IDs to feed into an on-demand execution.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with one of ReadSyntheticData, DataExport, or ExternalSyntheticIntegration typestring No Filter by monitor type: BROWSER or HTTP enabledboolean No Filter to enabled (true) or disabled (false) monitors locationstring No Filter to monitors assigned to a synthetic location tagstring No Filter by tag. Comma-separate to require several tags managementZonenumber No Filter to monitors in a management zone, by numeric zone ID
Parameter Type Description monitorsarray Matching synthetic monitors
Trigger an on-demand batch execution of synthetic monitors, for gating a deploy on a smoke test. Returns a batch ID to poll.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with syntheticExecutions.write or ExternalSyntheticIntegration monitorsjson Yes Monitors to run, as an array of objects with monitorId and optional locations and executionCount (e.g. [{"monitorId":"SYNTHETIC_TEST-123","executionCount":1}]). Execution count caps at 10 processingModestring No STANDARD, DISABLE_PROBLEM_DETECTION, or EXECUTIONS_DETAILS_ONLY failOnPerformanceIssueboolean No Treat a performance threshold breach as a failure stopOnProblemboolean No Stop the batch as soon as one monitor reports a problem takeScreenshotsOnSuccessboolean No Capture screenshots for successful browser executions too metadatajson No Key-value metadata to attach to the batch, e.g. the release version. Max 64 pairs, 1024 characters each
Parameter Type Description batchIdstring ID of the batch, to poll with Get Synthetic Batch triggeredCountnumber How many executions were triggered triggeringProblemsCountnumber How many executions could not be triggered triggeredarray Triggered executions, grouped by monitor ↳ monitorId string Monitor that was triggered ↳ executions array One entry per location the monitor ran from ↳ executionId string Execution ID ↳ locationId string Location the execution ran from triggeringProblemsDetailsarray Why each untriggered execution failed to start ↳ cause string Why the execution could not be triggered ↳ details string Detail behind the cause ↳ entityId string Entity the problem relates to ↳ executionId string Execution ID, when one was assigned ↳ locationId string Location the execution targeted
Get the status and failures of an on-demand synthetic batch execution. Poll it after triggering to gate a deploy on the result.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with syntheticExecutions.read, ReadSyntheticData, or ExternalSyntheticIntegration batchIdstring Yes Batch ID returned by Execute Synthetic Monitors
Parameter Type Description batchIdstring ID of the batch batchStatusstring RUNNING, SUCCESS, FAILED, FAILED_TO_EXECUTE, or NOT_TRIGGERED executedCountnumber Executions completed failedCountnumber Executions that failed failedToExecuteCountnumber Executions that never ran triggeredCountnumber Executions triggered triggeringProblemsCountnumber Executions that could not be triggered failedExecutionsarray Executions that ran and failed ↳ errorCode string Error code Dynatrace reported ↳ executionId string Execution ID ↳ executionStage string DATA_RETRIEVED, EXECUTED, NOT_TRIGGERED, TIMED_OUT, TRIGGERED, or WAITING ↳ executionTimestamp number Execution time in UTC ms ↳ failureMessage string Why the execution failed ↳ locationId string Location the execution ran from ↳ monitorId string Monitor that was executed failedToExecutearray Executions that never started ↳ errorCode string Error code Dynatrace reported ↳ executionId string Execution ID ↳ executionStage string DATA_RETRIEVED, EXECUTED, NOT_TRIGGERED, TIMED_OUT, TRIGGERED, or WAITING ↳ executionTimestamp number Execution time in UTC ms ↳ failureMessage string Why the execution failed ↳ locationId string Location the execution ran from ↳ monitorId string Monitor that was executed triggeringProblemsarray Reasons executions could not be triggered ↳ cause string Why the execution could not be triggered ↳ details string Detail behind the cause ↳ entityId string Entity the problem relates to ↳ executionId string Execution ID, when one was assigned ↳ locationId string Location the execution targeted metadatajson Key-value metadata supplied when the batch was triggered. Keys are caller-defined, so the shape is dynamic userIdstring Who triggered the batch
Get a single comment on a Dynatrace problem.
Parameter Type Description commentobject The requested comment
Replace the text of an existing comment on a Dynatrace problem.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the problems.write scope problemIdstring Yes ID of the problem the comment belongs to commentIdstring Yes ID of the comment to update messagestring Yes Replacement text of the comment contextstring No Context of the comment, shown alongside the author
Parameter Type Description problemIdstring ID of the problem commentIdstring ID of the updated comment messagestring Text the comment now carries contextstring Context of the comment
Delete a comment from a Dynatrace problem.
Parameter Type Description problemIdstring ID of the problem commentIdstring ID of the deleted comment deletedboolean Always true — a failed delete raises instead
Create a service-level objective from a metric expression, target, and evaluation timeframe.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the slo.write scope namestring Yes Name of the SLO targetnumber Yes Target success rate as a percentage, e.g. 99.5 warningnumber Yes Warning threshold as a percentage. Must sit above the target, e.g. 99.8 timeframestring Yes Evaluation timeframe in Dynatrace notation, e.g. -1d, -1w, or now-30d evaluationTypestring Yes Evaluation type. AGGREGATE is the only value the API accepts descriptionstring No Description of the SLO enabledboolean No Whether the SLO is evaluated. Dynatrace defaults it to false filterstring No Entity filter scoping the SLO, e.g. type("SERVICE"),tag("env:prod") metricExpressionstring No Metric expression the SLO evaluates, e.g. (100)*(builtin:service.errors.total.successCount:splitBy())/(builtin:service.requestCount.total:splitBy()) metricNamestring No Display name for the SLO metric burnRateVisualizationEnabledboolean No Show the error-budget burn rate on the SLO fastBurnThresholdnumber No Burn rate above which the SLO is considered fast-burning
Parameter Type Description sloIdstring ID of the created SLO, read from the Location header namestring Name the SLO was created with
Update an existing service-level objective. Every field is replaced, so send the complete definition.
Parameter Type Required Description environmentUrlstring Yes Dynatrace environment URL (e.g., https://abc12345.live.dynatrace.com , or https://your-activegate:9999/e/abc12345 for Managed) apiTokenstring Yes Dynatrace access token (dt0c01...) with the slo.write scope sloIdstring Yes ID of the SLO to update namestring Yes Name of the SLO targetnumber Yes Target success rate as a percentage, e.g. 99.5 warningnumber Yes Warning threshold as a percentage. Must sit above the target, e.g. 99.8 timeframestring Yes Evaluation timeframe in Dynatrace notation, e.g. -1d, -1w, or now-30d evaluationTypestring Yes Evaluation type. AGGREGATE is the only value the API accepts descriptionstring No Description of the SLO enabledboolean No Whether the SLO is evaluated. Dynatrace defaults it to false filterstring No Entity filter scoping the SLO, e.g. type("SERVICE"),tag("env:prod") metricExpressionstring No Metric expression the SLO evaluates, e.g. (100)*(builtin:service.errors.total.successCount:splitBy())/(builtin:service.requestCount.total:splitBy()) metricNamestring No Display name for the SLO metric burnRateVisualizationEnabledboolean No Show the error-budget burn rate on the SLO fastBurnThresholdnumber No Burn rate above which the SLO is considered fast-burning
Parameter Type Description sloIdstring ID of the updated SLO namestring Name the SLO now carries
Delete a service-level objective.
Parameter Type Description sloIdstring ID of the deleted SLO deletedboolean Always true — a failed delete raises instead