1. Home
  2. Docs
  3. API Documentation
  4. Storage
  5. DeleteFile

DeleteFile

Route: https://api.kayran.live/DeleteFile

Use this function to Remove files from your Storage.

Roles Required: Admin. Users and Private Users can only Remove Files they have uploaded.

Request Syntax

{

“apiKey”: “String”,
“name”: “String”

}


Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

name

Parameter Usage and Options :

The exact Name of the File you wish to Remove.

For example: file1.txt –> file1.txt (inc. the Extension).

Type :

String

Is it Optional ? :

No.


Successful Response

{

    “Error”: 0,

    “Function”: “DeleteFile”,

    “Data”: “File Deleted Successfully”

}

Errors and their Possible Causes

For more information, please refer to the General Errors section.