Unable To Use Maintenance Mode API

« Go Back


Article Number000003726
TitleUnable To Use Maintenance Mode API
URL NameUnable-to-use-Maintenance-Mode-API
Product ComponentOrchestrator
Sub ComponentAPI
Studio Version2021.10.4
Orchestrator Version2021.4.2
QuestionUnable to use Maintenance Mode API - Error 400 Bad Request.
Issue Description + Resolution

Issue Description: Using UiPath.WebAPI.Activities[1.9.2] 

Example: POST for https://ORCHESTRATOR_URL/api/Maintenance/Start?phase=Draining&force=true&killJobs=false


Resolution: Check to ensure that

  • The Force parameter is set to false if being used for /api/Maintenance/Start
  • Admin and Write permissions are required 
  • The Maintenance mode is only available to the Host Tenant.


Investigation Steps: Test with Postman

  • API call fails if the force parameter is set to true for /api/Maintenance/Start 

Example: POST for https://ORCHESTRATOR_URL/api/Maintenance/Start?phase=Draining&force=false&killJobs=false

During this time:

  • Robot communication with Orchestrator is still active (i.e. logs are uploaded, queue items are added);
  • No new jobs can be created;
  • Stop command is sent to all running jobs;
  • All schedules are paused;
  • The Orchestrator interface is unavailable to everyone during maintenance.

Note: If any jobs do not complete, or are too long to wait, you have the ability to send a Kill command for all remaining jobs using the killJobs parameter.


Results when tried to access the Orchestrator website:


Read more on the below:


Last Published Date3/1/2022 9:13 AM