Storage

Storage

Operations related to file and folder management in the File Storage.

Storage Endpoints

Check if a file or folder exists

Returns a 200 OK status if the file or folder exists at the specified path, and a 404 Not Found status if it does not.

Path Parameters
  • filePath
    string
    required

    URL-encoded file or folder path relative to the Storage root (e.g., 'MyFolder/MyFile.png').

Responses
  • 200

    The file or folder exists.

  • 404

    The file or folder does not exist.

HEAD/storage/{filePath}
curl https://your-portal.clickhelp.co/api/v1/storage/ \
  --request HEAD \
  --header 'Authorization: Basic username:password'
No Body

The file or folder exists.

Get file or folder information

Returns metadata for a file or folder. If the path points to a file, it returns a single file object. If it points to a folder, it returns an array of objects for the items inside.

Path Parameters
  • filePath
    string
    required

    URL-encoded file or folder path relative to the Storage root (e.g., 'MyFolder/MyFile.png').

Query Parameters
  • format
    const:
    base64

    For files only. Set to 'base64' to include the file content in the response.

  • filter
    string

    For folders only. A file name mask, e.g., '*.png'.

  • isRecursive
    boolean
    default:
    false

    For folders only. Whether to list contents recursively.

Responses
GET/storage/{filePath}
curl https://your-portal.clickhelp.co/api/v1/storage/ \
  --header 'Authorization: Basic username:password'

{
  "fileName": "…",
  "fileFullName": "…",
  "content": "…",
  "modifiedBy": "…",
  "modifiedOn": "2026-01-23T22:10:04.180Z",
  "size": 1,
  "isFolder": true
}

Successful operation.

Create a file or folder

Creates a new file or folder at the specified path. The file content should be base64-encoded.

Path Parameters
  • filePath
    string
    required

    URL-encoded file or folder path relative to the Storage root (e.g., 'MyFolder/MyFile.png').

Query Parameters
  • format
    const:
    base64
    required

    The encoding format of the file content.

  • isOverwrite
    boolean
    default:
    false

    Whether to overwrite an existing file.

Body
application/json

The file content and type.

Schema for creating a file or folder in Storage.

content
string | nullablebyte

Base64-encoded file content. Omitted or null for empty files or folders.

isFolder
boolean
default:
false

Set to true to create a folder. 'content' will be ignored.

Responses
  • 200

    File or folder created successfully.

POST/storage/{filePath}
curl https://your-portal.clickhelp.co/api/v1/storage/ \
  --request POST \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "",
  "isFolder": false
}'
No Body

File or folder created successfully.

Update a file

Updates the content of an existing file.

Path Parameters
  • filePath
    string
    required

    URL-encoded file or folder path relative to the Storage root (e.g., 'MyFolder/MyFile.png').

Body
application/json

The new base64-encoded content.

Schema for updating a file in Storage.

content
string byte
required

The new Base64-encoded file content.

updatedFields
string
required

A comma-separated list of fields to update. Must include 'content'.

Responses
  • 200

    File updated successfully.

PATCH/storage/{filePath}
curl https://your-portal.clickhelp.co/api/v1/storage/ \
  --request PATCH \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
  "content": "",
  "updatedFields": ""
}'
No Body

File updated successfully.

Delete a file or folder

Deletes a file or folder at the specified path.

Path Parameters
  • filePath
    string
    required

    URL-encoded file or folder path relative to the Storage root (e.g., 'MyFolder/MyFile.png').

Responses
  • 204

    File or folder deleted successfully.

DELETE/storage/{filePath}
curl https://your-portal.clickhelp.co/api/v1/storage/ \
  --request DELETE \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: text/plain;charset=UTF-8' \
  --data ""
No Body

File or folder deleted successfully.

Delete several files

Deletes multiple files or folders in a single batch operation.

Body
application/json

A list of full paths of the files/folders to delete.

Schema for deleting multiple files from Storage.

fileFullNames
array string[]
required
Responses
  • 204

    The files were deleted successfully.

DELETE/storage
curl https://your-portal.clickhelp.co/api/v1/storage \
  --request DELETE \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
  "fileFullNames": [
    ""
  ]
}'
No Body

The files were deleted successfully.