Корень публично части каталога :GLOBALSHARE (siteshare/public)

Обзор

Предоставляет административный доступ к файлам и каталогам, размещаемым в публичном разделе каталога :SITESHARE.

Эндпойнт позволяет администратору мастер-домена оперировать произвольными путями внутри каталога :SITESHARE минуя ssh-подключение к серверу или хранилищу.

Управление этим каталогом опирается на внешнюю синхронизацию, например подключение его к серверу NFS. Без внешней синхронизации в многосерверной системе этот каталог индивидуален для каждого сервера, управление им через API влияет только на сервер, исполняющий роль вебсервера.

Доступ к каталогу из сценариев происходит с помощью префикса категории каталогов ":SS_PUB/".

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/fs/targets/siteshare/public

Заливка группы файлов

GET

/rest/v1/fs/targets/siteshare/public

Получение списка файлов

GET

/rest/v1/fs/targets/siteshare/public/<filename>

Скачивание файла

PUT

/rest/v1/fs/targets/siteshare/public/<filename>

Перезаливка существующего файла

DELETE

/rest/v1/fs/targets/siteshare/public/<filename>

Удаление файла

HEAD

/rest/v1/fs/targets/siteshare/public/<filename>

Получение мета-информации о файле

Заливка группы файлов

Загрузка в коллекцию производится с помощью Content-Type: multipart/formdata.

В запросе может быть один или несколько файлов. Файлы размещаются под именами, указанными в заголовках Content-Disposition каждой части.

Если файл с указанным именем уже существует, то он не сохраняется и возвращает ошибку. В зависимости от Content-Type и наличия успешно размещенных файлов в запросе может быть возвращен неудачный HTTP-ответ, либо информация о неудаче в теле HTTP-ответа 200 OK.

Запрос

Пример запроса
POST /rest/v1/fs/targets/siteshare/public HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------boundary_69df8120352a996e

-----------boundary_69df8120352a996e
Content-Type: application/octet-stream
Content-Disposition: form-data; name="filename"; filename="somefile.txt"
Content-Transfer-Encoding: binary

BINARY BODY OF 'somefile.txt'
-----------boundary_69df8120352a996e--

Ответ

Пример ответа
[
  {
    "name": "somefile.txt",
    "size": 12345,
    "last_modified": "2026-07-20 10:39:10"
  }
]

Получение списка файлов

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: name, size, last_modified.

offset

int

Смещение в списке файлов, подлежащих выдаче.

limit

int

Максимальное количество файлов в списке.

order

array<object|str>

Порядок сортировки файлов в списке.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/fs/targets/siteshare/public HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "last_modified" : "2025-12-25 12:30:00",
    "name" : "myTest",
    "type" : "directory"
  },
  {
    "name": "somefile.txt",
    "size": 12345,
    "last_modified": "2026-07-20 10:39:10"
  }
]

Скачивание файла

Запрос

Table 2. Параметры запроса
Имя Тип Описание

attachment

bool

Тип выдачи. По умолчанию false.

true – выдаётся с заголовком Content-Disposition: attachment; filename=filename.ext либо Content-Disposition: attachment; filename*=UTF-8''%d1%84%d0%b0%d0%b9%d0%bb.ext, где файл.ext – имя файла в кодировке UTF-8 и URLencoded.

false – выдается без заголовка Content-Disposition.
Пример запроса
GET /rest/v1/fs/targets/siteshare/public/somefile.txt?attachment=true HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/octet-stream; charset=utf-8
Content-Disposition: attachment; filename*=UTF-8''somefile.txt

BINARY BODY OF 'somefile.txt'

Перезаливка существующего файла

Производит замену файла.

Загрузка одного файла производится либо с помощью Content-Type: multipart/formdata, либо с произвольным Content-Type не являющимся мультипартом.

Если загрузка происходит с Content-Type: multipart/formdata, то будет сохранён только первый файл (первая часть имеющая поле filename в заголовке Content-Disposition), а само название файла будет проигнорировано.

Запрос

Пример запроса (octet-stream)
PUT /rest/v1/fs/targets/siteshare/public/somefile.txt HTTP/1.1
Content-Type: application/octet-stream

BINARY BODY OF 'somefile.txt'
Пример запроса (multipart)
PUT /rest/v1/fs/targets/siteshare/public/somefile.txt HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------boundary_69df8120352a996e

-----------boundary_69df8120352a996e
Content-Type: application/octet-stream
Content-Disposition: form-data; name="somefile.txt"; filename="somefile.txt"
Content-Transfer-Encoding: binary

BINARY BODY OF 'somefile.txt'
-----------boundary_69df8120352a996e--

Ответ

Пример ответа
HTTP/1.1 204 No Content

Удаление файла

Запрос

Пример запроса
DELETE /rest/v1/fs/targets/siteshare/public/somefile.txt HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Получение мета-информации о файле

Возвращает мета-информацию о файле, содержащую в том числе размер в заголовке Content-Length.

Особенности

  • HTTP-ответ не содержит тела, несмотря на наличие заголовка Content-Length.

Запрос

Table 3. Параметры запроса
Имя Тип Описание

attachment

bool

Тип выдачи. По умолчанию false.

true – выдаётся с заголовком Content-Disposition: attachment; filename=filename.ext либо Content-Disposition: attachment; filename*=UTF-8''%d1%84%d0%b0%d0%b9%d0%bb.ext, где файл.ext – имя файла в кодировке UTF-8 и URLencoded.

false – выдается без заголовка Content-Disposition.
Пример запроса
HEAD /rest/v1/fs/targets/siteshare/public/somefile.txt?attachment=true HTTP/1.1

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
Content-Type: application/octet-stream
Last-Modified: Mon, 20 Jul 2026 10:39:10 GMT
Content-Disposition: attachment; filename=somefile.txt
Content-Length: 12345
Пример неуспешного ответа
HTTP/1.1 404 Not Found

См. также

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт