ServiceAdmin

Last published : Aug 14, 2026
ServiceAdmin APIs provide administrative access to the Services on a Broker. They are listed in the following table:
Method Method Type Description
all-services PUT Cancels all active Services on the Broker.
invocation PUT Cancels a specific invocation specified by the given Service ID and Invocation ID.
service PUT Cancels the Service specified by the given Service ID.
resources DELETE Removes resource files from both the staging and deployed areas.
deploy-resources POST Deploys resources.
all-service-info GET Retrieves Service information of all the Services on the Broker.
blacklisted-engines GET Retrieves a list of IDs of Engines that have been blacklisted for a specified Service.
completed-service-invocation-count GET Retrieves the number of completed invocations of the specified Service.
finished-service-count GET Retrieves the total number of finished Services on the Broker.
invocation-count GET Retrieves the total number of pending and running invocations on the Broker.
invocation-info GET Retrieves the information about a particular invocation of a Service, for the given Service ID and Invocation ID.
pending-invocation-count GET Retrieves the number of pending invocations on the Broker.
pending-service-invocation-count GET Retrieves the number of pending invocations of the specified Service.
registered-services GET Retrieves a list of all registered Services; returns null if no Services are registered.
running-invocation-count GET Retrieves the number of invocations currently executed by Engines on the Broker.
running-service-count GET Retrieves the total number of active Services on the Broker.
running-service-invocation-count GET Retrieves the number of invocations currently executed by Engines of the specified Service.
selected-invocation-info POST Retrieves information of the given Service and invocation IDs.
selected-service-info POST Retrieves information of the given Service IDs running on the Broker.
service-binding GET Retrieves the binding of the specified Service.
service-count GET Retrieves the total number of Services on the Broker.
service-ids GET Retrieves the list of all Service IDs on the Broker.
service-info GET Retrieves the Service information of the given Service ID.
service-info-by-properties POST Retrieves the Service information of all Services on the Broker that match the description condition.
service-invocation-count GET Retrieves the total number of invocations of the specified Service.
task-expiration-event-count GET Retrieves the total number of task expiration events of the specified Service.
available GET Retrieves whether the methods are available.
list-resources GET Lists resources on the Server.
register-service POST Registers the binding in the Service Registry; this must be done on the Primary Director.
all-finished-services DELETE Removes the information of all finished Services from the Broker.
finished-service DELETE Removes the information of finished Services from the Broker.
resource-exists GET Checks whether a file exists in the designated area.
expires PUT Sets whether Service information is removed during Service cleanup.
priority PUT Sets the priority of the specified Service.
unregister-service DELETE Unregisters the binding in the Service Registry; this must be done on the Primary Director.