Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Delete file/folder API

  • Updated: 1/12/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

Delete file/folder API

Use this API to delete objects (bots, files, or folders) from the public or your private workspace.

Prerequisites

Note: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.
  • Use the Authentication API to generate a JSON Web Token. See Authentication API.
  • You can delete bots, files, or folders from your private workspace. To delete objects from the public workspace, you must be assigned a role that contains the Delete bot permission on the folder that contains the objects that you want to delete.
  • If you are deleting a folder, ensure that it is empty. Only empty folders can be deleted.
  • To delete a file or folder, you must provide the object ID. Use one of the Repository Management list APIs to retrieve the object ID. Choosing a Repository Management list API

Procedure

  1. Add the authentication token to the request header.
  2. Use the DELETE method and endpoint URL: <control_room_URL>/v2/repository/files/{id}
    {id} is the object id of the file or folder that you want to delete.
  3. Send the request.
    Response body: A successful request returns the following message
    204 Successful delete
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback