Skip to content
ShipSquares

/backup-configs/{id}/restore-plan

GET
/backup-configs/{id}/restore-plan
 
curl --request GET \
  --url https://example.com/api/v1/backup-configs/example/restore-plan

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Query Parameters

Section titled “Query Parameters ”
targetTime
string
<= 40 characters
dataDir
string
<= 512 characters
baseRunId
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
base
required
Any of:
object
runId
required
string
location
required
string
finishedAt
required
Any of:
string
targetTime
required
Any of:
string
dataDir
required
string
steps
required
Array<object>
object
title
required
string
command
required
string
note
required
string
Example generated
{
  "base": {
    "runId": "example",
    "location": "example",
    "finishedAt": "example"
  },
  "targetTime": "example",
  "dataDir": "example",
  "steps": [
    {
      "title": "example",
      "command": "example"
    }
  ],
  "note": "example"
}

400

Section titled “400 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

404

Section titled “404 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}