Backups

This section will contain a more detailed description soon. For the time being, you can feel free to rely on the auto-generated information to get started!

Get manual, schedule and system generated backups

SecuritybearerAuth
Request
path Parameters
env_id
required
string <uuid>
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses
200

Successfully found backups

401

No or invalid API key provided to the request

404

Could not find the environment or the user does not have permissions to retrieve data

500

Error occurred while retrieving backups

get/sites/environments/{env_id}/backups
Request samples
Response samples
application/json
{
  • "environment": {
    }
}

Get downloadable backups

SecuritybearerAuth
Request
path Parameters
env_id
required
string <uuid>
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Responses
200

Successfully found downloadable backups

401

No or invalid API key provided to the request

404

Could not find the environment or the user does not have permissions to retrieve data

500

Error occurred while retrieving downloadable backups

get/sites/environments/{env_id}/downloadable-backups
Request samples
Response samples
application/json
{
  • "environment": {
    }
}

Restore a scheduled or manual or system generated backup to an environment

SecuritybearerAuth
Request
path Parameters
target_env_id
required
string <uuid>
Example: 54fb80af-576c-4fdc-ba4f-b596c83f15a1
Request Body schema: application/json
backup_id
required
number
env_display_name_of_backup
required
string
Responses
202

Restore backup to environment action started. Check MyKinsta for status

400

One or more of the required parameters were not provided to the request

401

No or invalid API key provided to the request

500

Error occurred while restoring backup to environment

post/sites/environments/{target_env_id}/backups/restore
Request samples
application/json
{
  • "backup_id": 123456789,
  • "env_display_name_of_backup": "my-env"
}
Response samples
application/json
{
  • "operation_id": "backups:restore-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  • "message": "Restoring a backup to environment in progress",
  • "status": 202
}