Open API v2 / Files & System / File System
File System
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a single folder content
Parameters
urlstring · query
Url.
Response
Pathstring · nullable
Path to the directory where the object will be created.
Namestring · nullable
Name of the file manager.
SizeBytesinteger
The size of the file in bytes.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
Extensionstring · nullable
The file format (e.g.,.pdf,.jpg,.zip).
IsEmptyboolean
True: The folder contains no files/subfolders, or the file is 0 bytes.
Urlstring · nullable
The public or signed permanent link to access/download the file.
DateUpdatedstring · date-time
Timestamp of the last modification.
IsFolderboolean
Logical check box.
SecureZoneIdsarray of strings
A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default.
curl "https://your-site.webinone.com/api/v2/admin/file-system" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/file-system", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/file-system", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/file-system', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/file-system"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"Path": "string",
"Name": "Example",
"SizeBytes": 0,
"Content": "string",
"Extension": "string",
"IsEmpty": false,
"Url": "https://example.com",
"DateUpdated": "2026-07-01T00: 00: 00Z",
"IsFolder": false,
"SecureZoneIds": [
"string"
]
}
]Creates a new file or folder
Body parameters
Pathstringrequired
Path to the directory where the object will be created.
Namestringrequired
Name of the file manager.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
IsFolderbooleanrequired
Logical check box. True — create a new directory. False — create a file.
CreateWithIncrementboolean
Automatic resolution of name conflicts. For folders, this is typically 0 or the sum of its contents.
Response
Pathstring · nullable
Path to the directory where the object will be created.
Namestring · nullable
Name of the file manager.
SizeBytesinteger
The size of the file in bytes.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
Extensionstring · nullable
The file format (e.g.,.pdf,.jpg,.zip).
IsEmptyboolean
True: The folder contains no files/subfolders, or the file is 0 bytes.
Urlstring · nullable
The public or signed permanent link to access/download the file.
DateUpdatedstring · date-time
Timestamp of the last modification.
IsFolderboolean
Logical check box.
SecureZoneIdsarray of strings
A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default.
curl -X POST "https://your-site.webinone.com/api/v2/admin/file-system" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Path":"string","Name":"Example","Content":"string","IsFolder":false,"CreateWithIncrement":false}'
await fetch("https://your-site.webinone.com/api/v2/admin/file-system", { method: "POST", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Path": "string", "Name": "Example", "Content": "string", "IsFolder": false, "CreateWithIncrement": false }) });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/file-system", headers={"Authorization": "Bearer <token>"}, json={ "Path": "string", "Name": "Example", "Content": "string", "IsFolder": False, "CreateWithIncrement": False } )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/file-system', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Path' => 'string', 'Name' => 'Example', 'Content' => 'string', 'IsFolder' => false, 'CreateWithIncrement' => false ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/file-system"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Path\":\"string\",\"Name\":\"Example\",\"Content\":\"string\",\"IsFolder\":false,\"CreateWithIncrement\":false}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Path": "string",
"Name": "Example",
"SizeBytes": 0,
"Content": "string",
"Extension": "string",
"IsEmpty": false,
"Url": "https://example.com",
"DateUpdated": "2026-07-01T00: 00: 00Z",
"IsFolder": false,
"SecureZoneIds": [
"string"
]
}Updates an existing file or folder
Body parameters
NewNamestringrequired
New name to rename the file or folder to.
Pathstringrequired
Path to the directory where the object will be created.
Namestringrequired
Name of the file manager.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
IsFolderbooleanrequired
Logical check box. True — create a new directory. False — create a file.
CreateWithIncrementboolean
Automatic resolution of name conflicts. For folders, this is typically 0 or the sum of its contents.
Response
Pathstring · nullable
Path to the directory where the object will be created.
Namestring · nullable
Name of the file manager.
SizeBytesinteger
The size of the file in bytes.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
Extensionstring · nullable
The file format (e.g.,.pdf,.jpg,.zip).
IsEmptyboolean
True: The folder contains no files/subfolders, or the file is 0 bytes.
Urlstring · nullable
The public or signed permanent link to access/download the file.
DateUpdatedstring · date-time
Timestamp of the last modification.
IsFolderboolean
Logical check box.
SecureZoneIdsarray of strings
A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/file-system" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"NewName":"Example","Path":"string","Name":"Example","Content":"string","IsFolder":false,"CreateWithIncrement":false}'
await fetch("https://your-site.webinone.com/api/v2/admin/file-system", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "NewName": "Example", "Path": "string", "Name": "Example", "Content": "string", "IsFolder": false, "CreateWithIncrement": false }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/file-system", headers={"Authorization": "Bearer <token>"}, json={ "NewName": "Example", "Path": "string", "Name": "Example", "Content": "string", "IsFolder": False, "CreateWithIncrement": False } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/file-system', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'NewName' => 'Example', 'Path' => 'string', 'Name' => 'Example', 'Content' => 'string', 'IsFolder' => false, 'CreateWithIncrement' => false ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/file-system"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"NewName\":\"Example\",\"Path\":\"string\",\"Name\":\"Example\",\"Content\":\"string\",\"IsFolder\":false,\"CreateWithIncrement\":false}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Path": "string",
"Name": "Example",
"SizeBytes": 0,
"Content": "string",
"Extension": "string",
"IsEmpty": false,
"Url": "https://example.com",
"DateUpdated": "2026-07-01T00: 00: 00Z",
"IsFolder": false,
"SecureZoneIds": [
"string"
]
}Deletes an existing file or folder
Body parameters
Urlstringrequired
URL.
IsFolderbooleanrequired
Logical check box. True — create a new directory. False — create a file.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/file-system" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Url":"https://example.com","IsFolder":false}'
await fetch("https://your-site.webinone.com/api/v2/admin/file-system", { method: "DELETE", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Url": "https://example.com", "IsFolder": false }) });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/file-system", headers={"Authorization": "Bearer <token>"}, json={ "Url": "https://example.com", "IsFolder": False } )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/file-system', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Url' => 'https://example.com', 'IsFolder' => false ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/file-system"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Url\":\"https://example.com\",\"IsFolder\":false}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Retrieves a single file content
Parameters
Urlstring · queryrequired
Url.
Response
Pathstring · nullable
Path to the directory where the object will be created.
Namestring · nullable
Name of the file manager.
SizeBytesinteger
The size of the file in bytes.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
Extensionstring · nullable
The file format (e.g.,.pdf,.jpg,.zip).
IsEmptyboolean
True: The folder contains no files/subfolders, or the file is 0 bytes.
Urlstring · nullable
The public or signed permanent link to access/download the file.
DateUpdatedstring · date-time
Timestamp of the last modification.
IsFolderboolean
Logical check box.
SecureZoneIdsarray of strings
A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default.
curl "https://your-site.webinone.com/api/v2/admin/file-system/content" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/file-system/content", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/file-system/content", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/file-system/content', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/file-system/content"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Path": "string",
"Name": "Example",
"SizeBytes": 0,
"Content": "string",
"Extension": "string",
"IsEmpty": false,
"Url": "https://example.com",
"DateUpdated": "2026-07-01T00: 00: 00Z",
"IsFolder": false,
"SecureZoneIds": [
"string"
]
}Creates a new files upload
Files to upload, sent via form-data.</p>
Response
Pathstring · nullable
Path to the directory where the object will be created.
Namestring · nullable
Name of the ifile manager.
SizeBytesinteger
The size of the file in bytes.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
Extensionstring · nullable
The file format (e.g.,.pdf,.jpg,.zip).
IsEmptyboolean
True: The folder contains no files/subfolders, or the file is 0 bytes.
Urlstring · nullable
The public or signed permanent link to access/download the file.
DateUpdatedstring · date-time
Timestamp of the last modification.
IsFolderboolean
Logical check box.
SecureZoneIdsarray of strings
A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default.
curl -X POST "https://your-site.webinone.com/api/v2/admin/file-system/files-upload" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/file-system/files-upload", { method: "POST", headers: { "Authorization": "Bearer <token>" } });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/file-system/files-upload", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/file-system/files-upload', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/file-system/files-upload"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"Path": "string",
"Name": "Example",
"SizeBytes": 0,
"Content": "string",
"Extension": "string",
"IsEmpty": false,
"Url": "https://example.com",
"DateUpdated": "2026-07-01T00: 00: 00Z",
"IsFolder": false,
"SecureZoneIds": [
"string"
]
}
]Sets a list of secure zones to a file or folder
Body parameters
Urlstringrequired
URL.
IsFolderbooleanrequired
Logical check box. True — create a new directory. False — create a file.
SecureZoneIdsarray of strings
Identifiers of the secure zones (membership levels) allowed to access the file or folder. Empty means no access restriction.
Response
Pathstring · nullable
Path to the directory where the object will be created.
Namestring · nullable
Name of the file manager.
SizeBytesinteger
The size of the file in bytes.
Contentstring · nullable
Usually returns null or a truncated string in list views, but contains the file data (e.g., Base64) when requesting a specific file.
Extensionstring · nullable
The file format (e.g.,.pdf,.jpg,.zip).
IsEmptyboolean
True: The folder contains no files/subfolders, or the file is 0 bytes.
Urlstring · nullable
The public or signed permanent link to access/download the file.
DateUpdatedstring · date-time
Timestamp of the last modification.
IsFolderboolean
Logical check box.
SecureZoneIdsarray of strings
A collection of identifiers for Access Control Lists (ACL). It defines which membership levels or secure zones have permission to view this file. Empty by default.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/file-system/secure-zone" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Url":"https://example.com","IsFolder":false,"SecureZoneIds":["string"]}'
await fetch("https://your-site.webinone.com/api/v2/admin/file-system/secure-zone", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Url": "https://example.com", "IsFolder": false, "SecureZoneIds": [ "string" ] }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/file-system/secure-zone", headers={"Authorization": "Bearer <token>"}, json={ "Url": "https://example.com", "IsFolder": False, "SecureZoneIds": ["string"] } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/file-system/secure-zone', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Url' => 'https://example.com', 'IsFolder' => false, 'SecureZoneIds' => ['string'] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/file-system/secure-zone"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Url\":\"https://example.com\",\"IsFolder\":false,\"SecureZoneIds\":[\"string\"]}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Path": "string",
"Name": "Example",
"SizeBytes": 0,
"Content": "string",
"Extension": "string",
"IsEmpty": false,
"Url": "https://example.com",
"DateUpdated": "2026-07-01T00: 00: 00Z",
"IsFolder": false,
"SecureZoneIds": [
"string"
]
}