Restores

Get all Restores

get

Get all Restores operations

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

pageinteger · min: 1Optional

page number

page_sizeinteger · min: 1Optional

items per page

service_idstring · min: 3Required

ServiceID Query

typestringOptional

physical or logical

orderstring · enumOptional

asc or desc

Possible values:

Responses

200

OK

application/json

pages_countintegerOptional

PagesCount counter of all pages

restores_countintegerOptional

RestoresCount holds count of the restores

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/skybackup/v1/restores

HTTPcURLJavaScriptPython

GET /skybackup/v1/restores?service_id=text HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "pages_count": 1,
  "restores": [
    {
      "backup_id": "text",
      "bucket": "text",
      "created_at": "text",
      "id": 1,
      "message": "text",
      "service_id": "text",
      "service_name": "text",
      "status": "text",
      "type": "text"
    }
  ],
  "restores_count": 1
}

Create Restore

post

Create new Restore operation

Authorizations

BearerAuth

X-API-KeystringRequired

Body

application/json

idstringRequired

key represents unique backup id

point_in_timestringOptional

timestamp represents date and time value in 'CCYY-MM-DD hh:mm:ss' format

service_idstringRequired

service id represents unique database id

Responses

200

OK

application/json

backup_idstringOptional

unique backup id

bucketstringOptional

bucket where the backup is located

created_atstringOptional

CreatedAt represents the time when the restore operation was triggered

idintegerOptional

id of the restore operation

messagestringOptional

message

service_idstringOptional

service id represents unique database id

service_namestringOptional

name of the database service

statusstringOptional

status of the restore operation

typestringOptional

type of the restore operation

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/skybackup/v1/restores

HTTPcURLJavaScriptPython

POST /skybackup/v1/restores HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "external_source": {
    "bucket": "text",
    "credentials": [
      1
    ],
    "encryption_key": "text",
    "method": "mysqldump"
  },
  "id": "text",
  "point_in_time": "text",
  "service_id": "text"
}

{
  "backup_id": "text",
  "bucket": "text",
  "created_at": "text",
  "id": 1,
  "message": "text",
  "service_id": "text",
  "service_name": "text",
  "status": "text",
  "type": "text"
}

Look up Services for Restore

post

Look up eligible Services for Restore by Backup ID

Authorizations

BearerAuth

X-API-KeystringRequired

Body

application/json

backup_idstringOptional

BackupID unique backup id

service_idstringOptional

ServiceID represents unique database id of the source service

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

post

/skybackup/v1/restores/lookup

HTTPcURLJavaScriptPython

POST /skybackup/v1/restores/lookup HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "backup_id": "text",
  "service_id": "text"
}

{
  "services": [
    {
      "service_id": "text",
      "service_name": "text"
    }
  ]
}

Look up Services for Point in time Restore

get

Look up eligible Services to provide backups for Point in time Restore

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

200

OK

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/skybackup/v1/restores/pointintime/lookup

HTTPcURLJavaScriptPython

GET /skybackup/v1/restores/pointintime/lookup HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "services": [
    {
      "end_time": "text",
      "service_id": "text",
      "service_name": "text",
      "start_time": "text"
    }
  ]
}

Get Restore

get

Get single Restore operation

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

idstringRequired

Restore ID

Responses

200

OK

application/json

backup_idstringOptional

unique backup id

bucketstringOptional

bucket where the backup is located

created_atstringOptional

CreatedAt represents the time when the restore operation was triggered

idintegerOptional

id of the restore operation

messagestringOptional

message

service_idstringOptional

service id represents unique database id

service_namestringOptional

name of the database service

statusstringOptional

status of the restore operation

typestringOptional

type of the restore operation

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/skybackup/v1/restores/{id}

HTTPcURLJavaScriptPython

GET /skybackup/v1/restores/{id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "backup_id": "text",
  "bucket": "text",
  "created_at": "text",
  "id": 1,
  "message": "text",
  "service_id": "text",
  "service_name": "text",
  "status": "text",
  "type": "text"
}

Delete Restore

delete

Delete single Restore operation

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

idstringRequired

Restore ID

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/skybackup/v1/restores/{id}

HTTPcURLJavaScriptPython

DELETE /skybackup/v1/restores/{id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content