Broker Admin

Last published : Jul 27, 2026
Broker Admin APIs provide administrative access to Brokers on a Director. 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-broker-info GET Retrieves information about all Brokers logged in to the Director.
broker-count GET Retrieves the total number of Brokers logged in to the Director.
broker-configuration PUT Updates the Broker configuration.
broker-info GET Retrieves information about a given Broker.
driver-weight PUT Sets the Driver distribution weighing relative to other Brokers.
engine-router GET Retrieves the Engine Router assigned to this Broker.
engine-router POST Sets an Engine Router for a given Broker.
engine-weight PUT Sets the Engine distribution weighing relative to other Brokers.
maximum-engines PUT Sets the maximum number of Engines the Broker can manage.
minimum-engines PUT Sets the minimum number of Engines the Broker has to manage.
min-idle-home-engines PUT Sets the minimum number of Idle Home Machines that the Broker has to manage.
purge-broker POST Removes the specified offline Broker.
service-discriminator GET Retrieves the PropertyConditionSet used by the Service Discriminator.
service-discriminator POST Adds the service discriminator.
service-discriminator DELETE Deletes the Service Discriminator.
service-discriminator-names GET Retrieves the names of all Service Discriminators.
shared-brokers GET Retrieves Broker sharing.
shared-brokers PUT Sets the Broker sharing.