Get Root Folder

Title

Get root folder

URL Path

vault_rest/root_folder

Method

GET

Http return

200, 400, 401, 403, 500

Table of Contents

Last Updated

08 Oct 2019

Summary

List information about the 'root' folder.

HTTP header parameters

Authorization

The API key of the caller

REQUIRED

This header should have the following format: Bearer [

API key obtained from the authenticate API]

Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

Method: GET

Request Error

400

Bad Request

Invalid HTTP request

401

Invalid parameter

One or more parameters are invalid

403

Forbidden

API key is incorrect

500

Internal Server Error

Server is temporarily unavailable

Response

Example of a successful scan request:

{
"availability_state": "Available",
"can_update_sharing": true,
"folder_id": "993a2573df374a86b7999002285aaa35",
"name": "",
"owner": "admin admin",
"owner_id": 1,
"path": "",
"folder_path_list": [
{
"availability_state": "Available",
"can_update_sharing": true,
"folder_id": "993a2573df374a86b7999002285aaa35",
"name": "",
"owner": "admin admin",
"owner_id": 1,
"path": ""
}
]
}