Nexfs Management API Documentation

Method Index

DeleteFile

Delete a file within the Nexfs Filesystem using the management API

Action: DeleteFile

Delete one file/Object within the Nexfs Filesystem

Permissions

The requesting session must have the nexfs/DeleteFiles role enabled.

Request Parameters

A request must be made against the nexfs management console api with the DeleteFile action.

The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.

Action

DeleteFile

Path

The path and name of the File / Object to be deleted

Request Body

The request does not have a request body.

Response Syntax

HTTP1/1 200

<?xml version="1.0" encoding="UTF-8"?>

<Code>string</Code>

<Message>string</Message>

<Resource>string</Resource>

<RequestId>integer</RequestId>

</RequestCompleted>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service:

RequestCompleted

Root Level tag for the successful Revoke Session response

Code

Message

Request Completed

Resource

/nexfsconsoleapi

RequestId

A requestid number that identifies the request made against the management api

Errors

Also See Rest Error Responses

400 BadRequest The request was Malformed

A BadRequest is returned if RequestJSON missing from the request

400 BadRequest The request was Malformed

A BadRequest is returned if the RequestJSON format is invalid

400 BadRequest <POSIX MESSAGE>

An error occurred while preforming the request, examples: file exists, user does not exist, group does not exist etc

401 Unauthorized The request cannot be authenticated

403 Forbidden Session does not have the rights to perform the requested action

500 InternalServerError An Internal Error was encountered

Example Request

GET /nexfsconsoleapi?Action=DeleteFile&Path=%2Fdefault_tenant%2Fnexfs%2Ftest_iscsi%2Fubkqbyuf%2Flevel1%2Flevel2%2Flevel3%2Flun1.img&SessionToken=30ea39edf6614e86a14c843028ff2580 HTTP/1.1\r\nAccept-Encoding: identity\r\nUser-Agent: python-urllib3/2.0.7\r\nhost: mgmtapi.nexfsbuild02.nexfs.com:9200\r\nx-amz-date: 20250506T030153Z\r\nAuthorization: AWS4-HMAC-SHA256 Credential=88a31956b0164704ac72a2eba7d8d28d/20250506/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-date, Signature=764a9dc3ca116e90fb1b4b2d9fea9d97be3f442ba4b3875dd199111264362639\r\n\r\n

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<Message>Request Completed</Message>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>