Service Admin

Last published : Jul 27, 2026
Service Admin APIs provide administrative access to the Services on a Broker. They are listed in the following table.
Method Method Type Description
available GET Retrieves whether the methods are available. Returns true if the method is available and false if the method is not available.
all-service-info GET Retrieves Service information of all the Services on the Broker.
all-services PUT Cancels all active Services on the Broker.
all-finished-services DELETE Removes the information of all finished Services from 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.
deploy-resources POST Deploys resources. This must be done on the Primary Director and Secondary Director Acting Primary only.
download-grid-library-xml GET Downloads the grid-library.xml for a specified gridlib.
expires PUT Sets whether Service information needs to be removed during Service cleanup.
finished-service-count GET Retrieves the total number of finished Services on the Broker.
finished-service DELETE Removes the information of finished Services from the Broker.
grid-library-xml GET Retrieves the grid-library.xml for a specified gridlib.
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.
invocation PUT Cancels a specific invocation specified by the given Service ID and Invocation ID.
list-resources GET Lists resources on the Server.
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.
priority PUT Sets the priority of the specified Service.
registered-services GET Retrieves a list of all registered Services; returns null if no Services are registered.
register-service POST Registers the binding in the Service Registry; this must be done on the Primary Director. This must be done on the Primary Director and Secondary Director Acting Primary only.
resource-exists GET Checks whether a file exists in the designated area.
resources DELETE Removes resource files from both the staging and deployed areas. This must be done on the Primary Director and Secondary Director Acting Primary only.
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.
service PUT Cancels the Service specified by the given Service ID.
task-expiration-event-count GET Retrieves the total number of task expiration events of the specified Service.
unregister-service DELETE Unregisters the binding in the Service Registry; this must be done on the Primary Director. This must be done on the Primary Director and Secondary Director Acting Primary only.