API Reference

Onyx Core API

Resources & Endpoints

Create a backup

Creates a backup for a site.

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

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

note

A note for the new backup

 String None

Potential Errors

The following errors may occur during this request.

Details HTTP status

backup_limit_reached

You have reached your maximum number of sites. Please upgrade your package to add new sites.

 402 Payment Required

site_not_found

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

 404 Not Found

validation_error

A validation error occurred with the object that was being created/updated/deleted

 422 Unprocessable Entity

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
        } ]
    }
}