Login/Register
Installatron Server
API Documentation
⌂

GET /set/backup_locations
Restriction: administrator only

View the configurations of all Installatron administration Backup Locations.

Parameters


API

/set/backup_locations
API endpoint.
GET
Method.

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 400
invalid_argument_uri
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
local
for the default backup location (the user's account).
Or an internal ID representing this backup location.
(eg.
1234567890abcdefghij12345
)
↳
default
boolean
true
to make this the default backup location for new installs, otherwise
false
.

default is
false
↳
desc
string
Optional more detailed description of the backup location.

default is empty
↳
enabled
boolean
true
to enable this backup location.
false
to disable this backup location.

default is
true
↳
name
string
Name of this backup location.
(eg.
My Dropbox Backups
)
↳
scope
string
What types of users have access to the backup location.

user
to make it available to admins, resellers, and users.
admin
to make it available only to the reseller or admin that created it.

default is
admin
for admin/reseller-created backup locations,
user
for user-created backup locations
↳
uri
string
URI to the backup location resource. Supported protocols:
  • dropbox
    Dropbox
    (eg.
    dropbox3://AccountId:RefreshToken@vhfs35tzjvyhukc
    )
    Note: Dropbox backup locations should be added via the UI because you will be required to provide Oauth access.
  • file
    local filesystem
    (eg.
    file://localhost/backup_test
    )
    Note: Only available for the server administrator account. Resellers and users cannot use this protocol.
    The example URI would essentially place the backups in the
    /backup_test
    folder of the server's root partition.
  • ftp
    password protected FTP
    (eg.
    ftp://abcDEF:ghiJKL@website.com:21/backup_test
    )
  • ftps
    FTP Secure Sockets Layer
    (eg.
    ftps://abcDEF:ghiJKL@website.com:22/backup_test
    )
  • sftp
    Secure FTP
    (eg.
    sftp://abcDEF:ghiJKL@website.com:22/backup_test
    )
  • gdrive
    Google Drive
    (eg.
    gdrive://google:RefreshToken@drive.google.com
    )
    Note: Google Drive backup locations should be added via the UI because you will be required to provide Oauth access.
  • rackspace
    Rackspace Technology
    (eg.
    rackspace://AccountId:SecretKey@Container
    )
  • s3
    Amazon S3 and S3-compatible services
    (eg.
    s3://AccessKey:SecretKey@Endpoint/Region/Bucket/Folder
    )
    (eg.
    s3://123ABC:12abAB@s3.us-east-1.amazonaws.com/us-east-1/s3.myhost.com/testprefix
    )
  • webdav
    Web Distributed Authoring and Versioning
    (eg.
    webdav://User:Pass@Endpoint/Folder
    )

Full Examples

Example: View all Installatron administration backup locations

Method: curl
Installatron Product: Installatron Server 
curl -X POST https://{SERVER_IP}/set/backup_locations \
    -H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
    -H 'X-HTTP-Method-Override: GET' \
    -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": "local",
            "default": true,
            "desc": "_tasks_backup_mywebhostingaccount",
            "enabled": true,
            "name": "_tasks_backup_myaccount",
            "scope": "admin",
            "uri": "local://account@localhost"
        },
        {
            "id": "1234567890abcdefghij123456789009",
            "default": false,
            "enabled": true,
            "name": "Example Dropbox Backup Location",
            "scope": "admin",
            "uri": "dropbox3://dbid%3A1234567890abcdefghijABCDEFGHIJ12345:1234567890abcdefghijABCDEFGHIJ1234567890abcdefg_12345abcdeABCDE0@abcdefghijklmno"
        },
        {
            "id": "1234567890abcdefghij123456789010",
            "default": false,
            "enabled": true,
            "name": "Example File System Backup Location",
            "scope": "admin",
            "uri": "file://localhost/backup"
        },
        {
            "id": "1234567890abcdefghij123456789011",
            "default": false,
            "enabled": true,
            "name": "Example Google Drive Backup Location",
            "scope": "admin",
            "uri": "gdrive://google:1%2F%2F012ab_12345abcdeABCDE12345ab-12345abcdeABCDE12-12345abcdeABCDE1-1234567890abcdefghijABCDEFGHIJ123456@drive.google.com"
        },
        {
            "id": "1234567890abcdefghij123456789012",
            "enabled": true,
            "default": false,
            "name": "Example S3 Backup Location",
            "scope": "admin",
            "uri": "s3://1234567890ABCDEFGHIJ:12abAB0%2B1234567890abcdefghijABCDEFGHIJ12@s3.us-east-1.amazonaws.com/us-east-1/s3.myexampledomain.com/exampleprefix"
        }
    ]
},


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