API Reference

Onyx Core API

Resources & Endpoints

Show Backup

Shows information about a backup.

GET
https://portal.onyx.io/api/v2/sites/{site}/backups/{backup}

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

site Required

Site Lookup None

backup Required

Site Backup Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

backup_not_found

No backup was found matching any of the criteria provided in the arguments

 404 Not Found

site_not_found

No site was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    backup: Backup {
        id: Integer
        status: String
        manual: Boolean
        note: String?
        created_at: Unix Timestamp
        database_backups: [ DatabaseBackup {
            id: Integer
            backup_id: Integer
            name: String
            created_at: Unix Timestamp
        } ]
    }
}