List backups for a WordPress installation
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.wpengineapi.com/v1/installs/example/backups?limit=100&offset=0"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <credentials>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}const url = 'https://api.wpengineapi.com/v1/installs/example/backups?limit=100&offset=0';const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.wpengineapi.com/v1/installs/example/backups?limit=100&offset=0' \ --header 'Authorization: Basic <credentials>'Returns a paginated list of backups for the specified WordPress installation,
in all states (requested, in_progress, completed, aborted).
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”ID of install
Query Parameters
Section titled “Query Parameters ”(Optional) The number of records to return
(Optional) The first record of the result set to be retrieved
Responses
Section titled “ Responses ”List of backups for install
object
Path to the previous page of results
Path to the next page of results
The total number of results
object
The unique identifier of the backup
State of the backup.
Human-readable description provided when the backup was requested
Timestamp when the backup was created
Timestamp when the backup completed. null while the backup is still in progress.
WordPress version of the install at the time the backup was taken
Example
{ "previous": "https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=0", "next": "https://api.wpengineapi.com/v1/example-endpoint?limit=100&offset=200", "count": 225, "results": [ { "id": "e41fa98f-ea80-4654-b229-a9b765d0863a", "status": "requested", "description": "Pre-deploy snapshot", "create_time": "2024-01-15T10:00:00Z", "complete_time": "2024-01-15T10:30:00Z", "wordpress_version": "6.4.2" } ]}Bad Request
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
An array of error objects describing specific errors that arose when servicing the request
object
The name of the resource that was being processed when the error occurred
(Optional) The specific field associated with the error
(Optional) A type associated with the error. invalid_value, access_error, value_unavailable
(Optional) A machine code relating to the error that occurred with the field and resource
(Optional) A human-readable message relating to the error that occurred with the field and resource
Example
{ "message": "Invalid Site: Name cannot be empty.", "errors": [ { "resource": "Site", "field": "name", "type": "invalid_value", "code": "too_long", "message": "Name is too long (maximum is 40 characters)" } ]}Authentication Error
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "Bad Credentials"}Not authorized
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "You don't have permission to perform that action"}Not found
object
A message regarding the error that occurred on the server
(Optional) A URL where documentation regarding this specific error can be found
Example
{ "message": "Not Found"}Too many requests
An invalid response was received from an upstream server
Service unavailable