ProtectedapiAPI base path (e.g., '/maximo/api')
ProtectedloggerProtectedhttpThe HTTP client for making requests
Returns the current logger used by this service instance.
ProtectedformatOptionalproperties: string | string[]ProtectedhandleError handler
the error to process
Get overall Manage Monitoring API details
MMI API data
Get all members
List of all members
Get details for a specific member
The server member ID (defaults to 'thisserver')
Lean information about the specific member
Checks the database connection and calculates the average response time that is required to run 10 recent queries. These queries are obtained from the system tables. The queries are run on Oracle and Db2® databases.
The server member ID (defaults to 'thisserver')
DB ping result
Get Cloud DB Statistics for a specific member
The server member ID (defaults to 'thisserver')
Cloud DB statistics
Get Cloud DB Storage details for a specific member
The server member ID (defaults to 'thisserver')
Cloud DB storage details
Provides the response time for connecting to Kafka and the status for Kafka connectivity.
The server member ID (defaults to 'thisserver')
Kafka ping result
Provides the response time for connecting to Cloud Object Storage and the status for Cloud Object Storage connectivity.
The server member ID (defaults to 'thisserver')
COS ping result
Get DB Manager Info for a specific member
The server member ID (defaults to 'thisserver')
DB Manager information
Provides information about the database that is used by the application, including information about the database version, vendor information, and driver information. Also provides links to the database connection pool details.
The server member ID (defaults to 'thisserver')
Database information
Counts the total cron threads running at this instant in the current server process. It also provides the peak count of cron threads on that server.
The server member ID (defaults to 'thisserver')
Cron Thread information
Get Class Information for a specific member, optionally filtered by a class name
The server member ID (defaults to 'thisserver')
OptionalclassName: stringOptional class name string to query specifics on exactly one class
General class information or specific class details
Provides information about the operating system that is used for the run time, including information about the OS type, version, architecture, and the number processors that are available.
The server member ID (defaults to 'thisserver')
OS details and stats
Provides information about the server heap and nonheap memory usage. All units are in Megabytes (MB).
The server member ID (defaults to 'thisserver')
Memory usage stats
Provides runtime thread count information that includes concurrent thread count and deadlocked thread counts.
The server member ID (defaults to 'thisserver')
Server threads details
Counts total thread pool size and total active thread pool count.
The server member ID (defaults to 'thisserver')
Thread Pool parameters
Provides request and response information about the OSLCServlet, RESTServlet, and UIServlet for each application that is deployed. The response time is measured in milliseconds.
The server member ID (defaults to 'thisserver')
Details about running servlets
Provides MBO count information. Also provides links to the MBO and the MboSet class. This class can be useful when you are trying to resolve out of memory (OOM) or performance issues.
The server member ID (defaults to 'thisserver')
Count metrics of Mbo memory structures
Provides the number of integration and UI objects that are exchanged per minute on each server.
The server member ID (defaults to 'thisserver')
API metrics and response time details
Provides information about the JAXP providers on the server.
The server member ID (defaults to 'thisserver')
Messaging provider metrics
Provides information about the state of a logger. The logger name can be provided to the API by using the oslc.where query parameter.
The server member ID (defaults to 'thisserver')
Current state and level of configured loggers
Get Cron stats for a specific member
The server member ID (defaults to 'thisserver')
Cron details
Provides information on total sessions, active sessions, and live sessions.
The server member ID (defaults to 'thisserver')
Active sessions and usage stats
Get details on Application Services for a specific member
The server member ID (defaults to 'thisserver')
Overview of internal Maximo services on this server member
Generate a heap dump of App Services for a specific member
The server member ID (defaults to 'thisserver')
Response regarding the heap dump trigger
Provides information about the five database tables that have the largest table size per day. The table size is measured in MB per day.
The server member ID (defaults to 'thisserver')
Relevant table sizes in db measured in MB per day
Get details about evaluated Formulas on a specific member
The server member ID (defaults to 'thisserver')
Formula metrics
Total number of reports that ran in the preceding hour and accumulated time in seconds that reports are run in a particular day. Information about concurrent report usage and daily runtime.
The server member ID (defaults to 'thisserver')
Report details and performance
Provides information about state of an integration queue. The resource allows consumers of the API to test the connectivity/read/write to the queue and to browse messages in the queue.
The server member ID (defaults to 'thisserver')
Details about processing queues
Provides information about the object structure cache. It identifies cases where invalid entries in the Object Structure tables might cause cache corruption.
The server member ID (defaults to 'thisserver')
Cache usage metrics
Provides information about the JVM that is hosting the application, including information about the start time, the JVM vendor, and the JVM version.
The server member ID (defaults to 'thisserver')
JVM garbage collection and state statistics
Get HTTP performance stats for a specific member
The server member ID (defaults to 'thisserver')
Information about HTTP handlers on the server
Trigger a JVM Heap Dump for a specific member
The server member ID (defaults to 'thisserver')
Server response acknowledging completion/start of heap dump
Provides information about the event subscription tree. The resource describes information about event topics, such as add asset or update work order, and the listeners that are associated with those topics.
The server member ID (defaults to 'thisserver')
Event tree metrics
Provides the total count of MXApplicationException and MXSystemException exceptions that are created.
The server member ID (defaults to 'thisserver')
Information about internal error occurrences
Get Child Directories recursively for an exposed Global Dir on a specific member
The server member ID (defaults to 'thisserver')
Tree of matching global dirs available to the API
Provides metadata for the Application Health Insights (AHI) card — the tile that surfaces aggregated health/scoring information for the Maximo application server tab.
The server member ID (defaults to 'thisserver')
AHI card details
Provides AHI (Application Health Insights) scoring information for a specific member, including the crontask, escalations, and scoring method used to compute the health score.
The server member ID (defaults to 'thisserver')
AHI scoring details
Lean variant of getAppServices — same internal services list
without the spi: prefixed properties. Faster and smaller payload,
useful for dashboards that just need names and statuses.
The server member ID (defaults to 'thisserver')
Application services overview (lean)
Lean variant of getCron — cron task list without the spi:
prefixed properties. Lighter payload for cron listing UIs.
The server member ID (defaults to 'thisserver')
Cron task list (lean)
Dedicated lean endpoint for the event subscription tree. Returns the same
topic/listener structure as getEventTree but at a different path
(eventtreelean) and without the spi: prefixes. Use this for very
large event trees where transport size matters.
The server member ID (defaults to 'thisserver')
Event subscription tree (lean)
Provides information about the Integration Global Directory — the filesystem path Maximo uses for inbound/outbound integration files, its free space, and a link to the child directory tree.
The server member ID (defaults to 'thisserver')
Integration global directory details
Lean variant of getGlobalDir — Integration Global Directory
details without the spi: prefixed properties.
The server member ID (defaults to 'thisserver')
Integration global directory details (lean)
Provides information about the JAXP (Java API for XML Processing) implementations registered with the JVM — DocumentBuilder factory, XPath factory, Transformer factory, and SAXParser factory.
The server member ID (defaults to 'thisserver')
JAXP factory implementation details
Probes the configured LDAP server with a search request. Returns BMXAA6740E when LDAP is not configured on the target environment; otherwise returns the configured search base + filter results. Useful for diagnosing security/SSO issues without leaving the API surface.
The server member ID (defaults to 'thisserver')
LDAP search probe result
Lean variant of getLoggers — active logger list without the
spi: prefixed properties.
The server member ID (defaults to 'thisserver')
Active logger list (lean)
Provides the Maximo Integration Framework (MIF) web services registry — the list of currently registered/exposed MIF web services, with their names, endpoints, and associated object structures.
The server member ID (defaults to 'thisserver')
MIF web services registry
Lean variant of getMifWebServices — MIF web services registry
without the spi: prefixed properties.
The server member ID (defaults to 'thisserver')
MIF web services registry (lean)
Provides information about the OSLC stable cache — the in-memory cache Maximo uses to keep frequently accessed OSLC resources hot. Includes lifeSpan, sleepInterval, and a link to the cached resources list.
The server member ID (defaults to 'thisserver')
OSLC stable cache configuration and stats
Lean variant of getOslcStableCache — OSLC stable cache config
without the spi: prefixed properties.
The server member ID (defaults to 'thisserver')
OSLC stable cache configuration (lean)
Provides Performance Monitoring Infrastructure (PMI) configuration — the registered PMI endpoints and the system properties that control PMI behavior.
The server member ID (defaults to 'thisserver')
PMI configuration details
Provides the JVM input arguments — every -X / -XX flag passed on
the JVM command line (e.g. -Xmx, -XX:+UseG1GC). This is the
authoritative source for tuning flags actually in effect at runtime.
Surfaced as a child resource under getJvm (jvm.inputArgs).
The server member ID (defaults to 'thisserver')
JVM input arguments list
Provides the JVM system properties — every -D property visible to
the runtime, including Maximo-specific ones (mxe.*). Child resource
under getJvm (jvm.systemProperties).
The server member ID (defaults to 'thisserver')
JVM system properties
Provides a full live thread dump of the JVM — every thread, its state,
lock owners, and full stack trace. The go-to endpoint for diagnosing
hangs, deadlocks, and runaway threads. Child resource under
getThreads (threads.threadDump).
The server member ID (defaults to 'thisserver')
Full thread dump
Provides database connection pool details — Free / Total / Used counts, long-running connections, and a connection trace. The primary endpoint for diagnosing connection-pool exhaustion.
Note: in Maximo's dbinfo response this is exposed under the JSON
field name dbConnection, but its actual URL path is dbinfo/dbmanager
— Maximo's dbConnection.resource link points at /dbmanager. This
method is an alias for getDbManagerInfo, kept under the name
MMI consumers expect when reading from dbinfo.
The server member ID (defaults to 'thisserver')
Database connection pool stats
Lean variant of getChildDirs — Integration Global Directory
child directories without the spi: prefixed properties. Child resource
under getGlobalDirLean (globaldirlean.childDirsLean).
Note: Maximo's JSON field name is childDirsLean (camelCase) but the
actual URL path is childdirslean (all lowercase).
The server member ID (defaults to 'thisserver')
Integration global directory child dirs (lean)
Lists the resources currently held in the OSLC stable cache. Child
resource under getOslcStableCache (oslcstablecache.stableResources).
Useful for verifying cache warm-up and seeing which entities are hot.
The server member ID (defaults to 'thisserver')
OSLC stable cache resources list
Lean variant of getOslcStableCacheResources — OSLC stable cache
resources without the spi: prefixed properties. Child resource under
getOslcStableCacheLean (oslcstablecachelean.stableResourcesLean).
The server member ID (defaults to 'thisserver')
OSLC stable cache resources list (lean)
Provides the count of integration and UI MBOs exchanged since startup.
Useful for tracking integration throughput. The response carries two
counters: integrationmbocount and uimbocount.
The server member ID (defaults to 'thisserver')
Object-exchange counters
Executes an action on an arbitrary endpoint Useful for service endpoints that don't follow the standard resource/ID pattern Supports both GET and POST methods based on payload presence
The endpoint to call the action on (e.g., 'service/logging')
The name of the action to execute (e.g., 'wsmethod:streamLog')
Optionalpayload: anyOptional payload data for the action (if provided, uses POST, otherwise GET)
OptionalreturnProperties: string | string[]Optional properties to return in the response
A promise resolving to a response object containing success status and optional data
Service to interact with the Maximo Manage Monitoring (MMI) APIs