Login/Register
Installatron Server
API Documentation
⌂

method /set/backup_schedules
Restriction: administrator only

View the configurations of all Installatron administration Backup Schedules.

Parameters


API

/set/backup_schedules
API endpoint.
method
GET

Optional parameters

user
string
Change scope to this Installatron Server admin, reseller, or user.

default is the current user
group
string
Change scope to this Settings Group.

default is the default group

Response


Response

status
int
HTTP status code describing the result of the request.

200
for Success.
All other numbers represent errors which are described in the errcode output below.
result
boolean
true
= Success.
false
= Failure.
errcode
string
status code 403
invalid_api_key
The server's Installatron Server Key is invalid.
errfield
enum
If the cause of an error was an incorrect field value then this will show the ID of the field.
(eg.
login
,
passwd
,
email
)
message
string
Message describing the result of the request. Do not rely on this to determine the success or failure of the request.
data[]


↳
id
string
weeklymonthly
for the default backup schedule of 1 weekly, 1 monthly backups.
dailyweeklymonthly
for the default backup schedule of 1 daily, 1 weekly, 1 monthly backups.
daily30
for the default backup schedule of 30 daily backups.
Or an internal ID representing this backup schedule.
(eg.
1234567890abcdefghij12345
)
↳
daily
int
Number of daily backups to retain.

default is
1
↳
weekly
int
Number of daily backups to retain.

default is
0
↳
monthly
int
Number of daily backups to retain.

default is
0
↳
enabled
boolean
true
to enable this backup schedule.
false
to disable this backup schedule.

default is
true
↳
forced
boolean
true
to make this a forced backup schedule (a schedule that automatically creates backups at the configured schedule).
false
to make this a regular schedule.

default is
false
↳
location
string
 
(empty string) to store these forced backups in the install's Default Backups Location.
local
to store these forced backups in the user's account.
Or the internal ID of a backup location to store these forced backups in that specific backup location.

default is empty
↳
name
string
Name of this backup schedule.
↳
retainable
boolean
(Only when forced is
true
)
true
to allow users to keep a backup created by this forced backup schedule.
false
to always expire forced backups after the configured number of days.


default is
true

Full Examples

Example: View all Installatron administration backup schedules

Method: curl
Installatron Product: Installatron Server 
curl -X POST https://{SERVER_IP}/set/backup_schedules \
    -H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
    -H 'Accept: application/json'
Response: json
{
    "result": true,
    "status": 200,
    "errcode": null,
    "errfield": null,
    "message": "The task is complete.\n"
    "total_count": 5,
    "has_more": false,
    "data":[
        {
            "id": "weeklymonthly",
            "daily": 0,
            "weekly": 1,
            "monthly": 1,
            "apps": "",
            "enabled": true,
            "forced": false,
            "location": "",
            "name": "",
        },
        {
            "id": "dailyweeklymonthly",
            "daily": 1,
            "weekly": 1,
            "monthly": 1,
            "apps": "",
            "enabled": true,
            "forced": false,
            "location": "",
            "name": "",
        },
        {
            "id": "daily30",
            "daily": 30,
            "weekly": 0,
            "monthly": 0,
            "apps": "",
            "enabled": true,
            "forced": false,
            "location": "",
            "name": "",
        },
        {
            "id": "1234567890abcdefghij123456789012",
            "daily": 1,
            "weekly": 2,
            "monthly": 3,
            "apps": "",
            "enabled": true,
            "forced": false,
            "location": "",
            "name": "Example Backup Schedule",
        },
        {
            "id": "1234567890abcdefghij123456789012",
            "daily": 0,
            "weekly": 0,
            "monthly": 1,
            "apps": "",
            "enabled": false,
            "forced": true,
            "location": "",
            "name": "Example Forced Backup Schedule",
            "retainable": true
        }
    ]
},


© 2004 - 2025 Installatron LLC. All rights reserved. Privacy Policy.