minimusdocs
Help center

Backups

Update a backup schedule

PATCH/backups/schedules/{id}/

manage Delete and money: deletes, credits, servers or panel settings. Scopes

Leave passphrase out to keep the one already set. Panel operators only.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Backup Schedule.

Body

  • namestring
  • enabledboolean
  • scopestring
  • componentsstring[]

    One of: "accounts" "lines" "credits" "categories" "bouquets" "streams" "media" "movies" "tv_series" "servers" "access_control" "settings" "viewing_history" "api_calls" "server_metrics" "task_history" "panel_imports" "playlist_editor" "playlist_editor_history" "providers" "watch_folders" "provider_history" "admin_log" "key_files"

  • destinationsstring (uuid)[]
  • frequencystring
  • time_of_daystring (time)

    Daily, weekly and monthly runs; for "every few hours" only the minute is used.

  • every_hoursinteger
  • weekdayinteger

    0 is Monday.

  • day_of_monthinteger

    1 to 28, so it exists in every month.

  • timezonestring
  • keep_lastinteger

    Older backups of this schedule are deleted. 0 keeps all.

  • keep_daysinteger

    Backups older than this are deleted. 0 keeps them regardless of age.

  • compressioninteger
  • encryptboolean
  • passphrasestring

Response

200 OK

  • idstring (uuid)requiredread-only
  • namestringrequired
  • enabledboolean
  • scopestring
  • componentsstring[]

    One of: "accounts" "lines" "credits" "categories" "bouquets" "streams" "media" "movies" "tv_series" "servers" "access_control" "settings" "viewing_history" "api_calls" "server_metrics" "task_history" "panel_imports" "playlist_editor" "playlist_editor_history" "providers" "watch_folders" "provider_history" "admin_log" "key_files"

  • destinationsstring (uuid)[]required
  • destination_namesstring[]requiredread-only
  • frequencystring
  • time_of_daystring (time)

    Daily, weekly and monthly runs; for "every few hours" only the minute is used.

  • every_hoursinteger
  • weekdayinteger

    0 is Monday.

  • day_of_monthinteger

    1 to 28, so it exists in every month.

  • timezonestring
  • keep_lastinteger

    Older backups of this schedule are deleted. 0 keeps all.

  • keep_daysinteger

    Backups older than this are deleted. 0 keeps them regardless of age.

  • compressioninteger
  • encryptboolean
  • has_passphrasebooleanrequiredread-only
  • next_run_atstring (date-time)requiredread-onlycan be null
  • last_run_atstring (date-time)requiredread-onlycan be null
  • schedule_labelstringrequiredread-only
  • contents_labelstringrequiredread-only
  • last_backupobjectrequiredread-onlycan be null
    • idstringrequired
    • statusstringrequired
    • status_labelstringrequired
    • finished_atstring (date-time)requiredcan be null
    • size_bytesintegerrequired
    • messagestringrequired
  • created_atstring (date-time)requiredread-only
  • updated_atstring (date-time)requiredread-only

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means