Delete Managed File or Directory

Removes an existing file or directory of a specific Managed File ID (or Name) from the File Store.

Request takes no content, and on success returns a response containing the result of the request for removal (“true” or “false”).

Request

Method Type:

GET

URI:

/rest/serverengine/filestore/delete/{fileId}

Content:
Content Type:

Add. Headers:

If server security settings are enabled, then one of the following:

  • Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded)
  • auth_token – Authorization Token

Parameters

Path

Name Required Type Default Value Description
fileId

The Managed File ID (or Name) of the file or directory in File Store

Response

Success

The following lists status codes indicative of a successful response:

Status Code Content Content-Type Add. Headers Description
200
OK
Result of request for removal text/plain Removal of file or directory successfully requested from File Store (response of “true” for success or “false” for failure)

Error

The following lists status codes indicative of a failed or error response:

Status Code Content Content-Type Add. Headers Description

401 Unauthorized

WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)

Server authentication is required.

Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

401 Unauthorized

Error message

Server authentication has failed.

Response when the authorization token specified in the request headers has now expired.

403 Forbidden

Error message

Server authentication has failed.

Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.

404
Not Found

  • File or directory not found in File Store