ToAPIsToAPIs
Файлы пользователя

Установить срок хранения файлов

Установка или сброс пользовательского срока хранения файлов

PUT
/api/v1/user/file/retention

Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.

Поведение

Устанавливает срок хранения файлов текущего аккаунта в днях. 7 означает 7 дней от создания. Отправьте null, чтобы снять собственную настройку и применять правила платформы.

Срок платформы по умолчанию: 30 дней. Действующий предел определяется текущей конфигурацией платформы. Пользовательское значение не может превышать его: при пределе 30 дней значение 30 принимается, а 31 возвращает 400. Настройка применяется к существующим и новым обычным файлам при включённой автоочистке.

Удаление асинхронное. Сокращение срока может включить существующие файлы в следующую очистку. Продление или сброс не отменяет уже начавшееся удаление и ранее поданные ручные запросы.

Параметры строки запроса не принимаются. Тело должно быть JSON-объектом не более 4096 байт; неизвестные и повторные поля отклоняются. Срок чтения тела: 10 секунд. Запись публичного аккаунта делит лимит 10 запросов в минуту на пользователя. Временная недоступность сервиса возвращает 503.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте системный токен доступа: Bearer YOUR_SYSTEM_ACCESS_TOKEN. Ключи моделей не принимаются, X-User-Id не нужен. Доступны только файлы и настройки текущего аккаунта, без объединения данных субаккаунтов.

Параметры запроса

retention_daysintegerтелообязательно

Обязательное положительное целое JSON-число или null. Число не должно превышать текущий предел платформы, по умолчанию 30 дней. 7 означает 7 дней, null снимает свою настройку и применяет правила платформы. Пропуск, 0, отрицательные и дробные числа, числовые строки недопустимы.

Пример запроса

curl --request PUT \
  --url 'https://api.toapis.com/api/v1/user/file/retention' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"retention_days":7}'
import requests

response = requests.put(
    "https://api.toapis.com/api/v1/user/file/retention",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    json={"retention_days": 7},
    timeout=30,
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.toapis.com/api/v1/user/file/retention", {
  method: "PUT",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN", "Content-Type": "application/json" },
  body: JSON.stringify({"retention_days": 7}),
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

Снять пользовательский срок:

curl --request PUT \
  --url 'https://api.toapis.com/api/v1/user/file/retention' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"retention_days":null}'

Поля ответа

Данные примеров вымышлены. Общий формат ответа см. в разделе Подключение.

data.retention_daysinteger | null

Пользовательский срок в днях. При null действуют правила платформы, по умолчанию 30 дней.

Пример ответа

{
  "code": 0,
  "message": "",
  "data": {
    "retention_days": 7
  }
}

Ошибки

Превышение текущего предела возвращает 400 (code=17052), настройка не сохраняется. Сообщение локализуется по Accept-Language и указывает допустимый диапазон целых чисел; data.params.max содержит текущий максимум дней.

Отсутствующий или неверный retention_days, некорректный JSON или параметры строки запроса возвращают 400. Временная недоступность сервиса возвращает 503 (code=13035).

Общие правила авторизации, лимитов и ошибок см. в разделе Подключение.