Try it free

Get a JMX process

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026
  • Early Access

Retrieve details for a Java process available for JMX metric collection in Dynatrace with the Extensions 2.0 API, using the process ID and optional filter.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/extensions/v2/discovery/jmx/processes/{process-id}

Overview

You provide the process-id path parameter to select a discovered Java process and can use the filter query parameter to refine the result. The operation returns a success response with the process details.

Authentication

To execute this request, you need a platform token or OAuth access token with extensions:discovery.jmx:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
process-idstring

Id of the Java process discovered in the environment for JMX metric collection.

pathRequired
filterstring

The filter parameter, as explained here.

Filtering is supported on the following field:

  • hostId - the ID of the host the process is running on, in the form HOST-XXXXXXXXXXXXXXXX.

If the parameter is omitted, all processes are returned.

Example: hostId = 'HOST-1234ABCD5678EFAB'

queryOptional

Response

Response codes

CodeTypeDescription
200JavaProcessDetails

Success.

404ErrorEnvelope

Failed. Agent data isn't yet available. Try again in a few seconds.

504ErrorEnvelope

Failed. Agent communication timeout.

4XXErrorEnvelope

Client error.

5XXErrorEnvelope

Server error.

Response body objects

The JavaProcessDetails object

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code.

detailsErrorDetails

The error details.

messagestring

The error message.

The ErrorDetails object

The error details.

ElementTypeDescription
constraintViolationsConstraintViolation[]

A list of constraint violations.

The ConstraintViolation object

A list of constraint violations.

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
"jdk.management": {
"com.sun.management.internal.VirtualThreadSchedulerImpls$VirtualThreadSchedulerImpl": [
{
"properties": {
"type": "VirtualThreadScheduler"
},
"metrics": [
{
"name": "Parallelism",
"numeric": true
},
{
"name": "PoolSize",
"numeric": true
},
{
"name": "MountedVirtualThreadCount",
"numeric": true
},
{
"name": "QueuedVirtualThreadCount",
"numeric": true
},
{
"name": "ObjectName",
"numeric": false
}
],
"fullPath": "jdk.management:type=VirtualThreadScheduler"
}
]
},
"java.util.logging": {
"sun.management.ManagementFactoryHelper$PlatformLoggingImpl": [
{
"properties": {
"type": "Logging"
},
"metrics": [
{
"name": "ObjectName",
"numeric": false
}
],
"fullPath": "java.util.logging:type=Logging"
}
]
}
}
{
"error": {
"code": 404,
"message": "Agent returned error code: JMX_NOT_YET_READY"
}
}
Related tags
Platform APIDynatrace PlatformInfrastructure Observability