Table of contents
Storage

Folders

Download API definition:

DELETE https://api.bentley.com/storage/folders/{folderId}

Delete a folder

Notes

Folder moved to the recycle bin will be completely removed after 30 days.

Authentication

Requires Authorization header with valid Bearer token for scope storage:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have storage_delete permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Request parameters

Name
In
Required?
Description
folderId
template
Yes

Folder Id

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope storage:modify

Accept
Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response 204 No Content

A folder was deleted successfully.

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

Folder cannot be found.

json
{
    "error": {
        "code": "FolderNotFound",
        "message": "Requested folder is not available."
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json
{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

Name
Description
retry-after

The number of requests exceeds the rate-limit for the client subscription.

Error

Contains error information.

TableSchema
Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String

The target of the error.

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

TableSchema
Name
Type
Description
error

Error information.