• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Table of contents
    Overview
    Tutorials
    Samples
    Changelog
    Storage
    Download API definition:
    Delete file
    DELETE https://qa-api.bentley.com/storage/files/{fileId}

    Delete the File with the provided fileId.

    The fileId MUST be provided in the parameters.

    Parameters

    fileId – Id of the file which you want to delete.

    Notes

    Deleted file will be moved to recycle bin. You can restore the deleted file with in 30 days.

    After 30 days, the file will be permanently removed from the Recycle Bin

    Authentication

    Requires Authorization header with valid Bearer token for scope itwin-platform.

    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

    Request parameters

    Name
    Required?
    Description
    fileId
    Yes

    Id of the file which you want to delete.

    Request headers

    Name
    Required?
    Description
    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

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

    Response

    Response 204 No Content

    A file 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

    File cannot be found.

    json
    {
    "error": {
        "code": "FileNotFound",
        "message": "Requested file 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.

    Definitions

    Error

    Contains error information.

    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, null

    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.

    Name
    Type
    Description
    error
    Error

    Error information.