Documentation for the GridServer Admin API

Last published : Jul 27, 2026
Detailed documentation on GridServer Admin API is in the API documentation. The WSDL is available in the GridServer Administration Tool at Grid Components > Drivers > Web Services.
The following components are defined:
  • BatchAdmin
  • BrokerAdmin
  • DriverAdmin
  • DriverManager
  • EngineAdmin
  • EngineDaemonAdmin
  • ManagerAdmin
  • ServiceAdmin
  • UserAdmin
  • Version
The methods allowed are based on the Security Roles of the user. When called in a Service, the user is considered to be the user that created the Service Session. When called in a Server Hook, all methods are available. Note that methods return null if there is no output, as opposed to returning a zero-length array. For example, EngineAdmin.getAllEngineInfo() returns null if there are no Engines currently logged in to the Broker.
See the Admin > User Admin > Role Admin page on the Administration Tool for a list of all permissions.
Related information