Skip to content
ShipSquares

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

POST
/backup-configs/{id}/restore-run
 
curl --request POST \
  --url https://example.com/api/v1/backup-configs/example/restore-run \
  --header 'Content-Type: application/json' \
  --data '{ "targetTime": "example", "baseRunId": "example", "port": 1 }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
targetTime
string
<= 40 characters
baseRunId
string
port
integer
>= 1024 <= 65535
Example generated
{
  "targetTime": "example",
  "baseRunId": "example",
  "port": 1
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
ok
required
boolean
container
required
Any of:
string
port
required
Any of:
integer
pgVersion
required
Any of:
string
recovered
required
boolean
error
string
Example generated
{
  "ok": true,
  "container": "example",
  "port": 1,
  "pgVersion": "example",
  "recovered": true,
  "error": "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"
    }
  ]
}