Skip to content
ShipSquares

/backup-configs (POST)

POST
/backup-configs
 
curl --request POST \
  --url https://example.com/api/v1/backup-configs \
  --header 'Content-Type: application/json' \
  --data '{ "serverId": "example", "databaseId": "example", "schedule": "example", "keepNewest": 1, "retentionDays": 1, "dest": { "provider": "example", "accessKeyId": "example", "secretAccessKey": "example", "region": "example", "endpoint": "example", "bucket": "example" }, "prefix": "example" }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
serverId
required
string
databaseId
required
string
schedule
required
string
>= 9 characters <= 64 characters
keepNewest
integer
>= 1 <= 365
retentionDays
integer
>= 1 <= 3650
dest
required
object
provider
required
string
>= 1 characters <= 64 characters
accessKeyId
required
string
>= 1 characters <= 256 characters
secretAccessKey
required
string
>= 1 characters <= 256 characters
region
string
<= 64 characters
endpoint
string
<= 2048 characters
bucket
required
string
>= 1 characters <= 255 characters
prefix
string
<= 255 characters
Example generated
{
  "serverId": "example",
  "databaseId": "example",
  "schedule": "example",
  "keepNewest": 1,
  "retentionDays": 1,
  "dest": {
    "provider": "example",
    "accessKeyId": "example",
    "secretAccessKey": "example",
    "region": "example",
    "endpoint": "example",
    "bucket": "example"
  },
  "prefix": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Default Response

Media type application/json
object
id
required
string
serverId
required
string
databaseId
required
Any of:
string
type
required
string
schedule
required
string
walArchive
required
boolean
walSchedule
required
Any of:
string
keepNewest
required
integer
retentionDays
required
integer
enabled
required
boolean
lastWalAt
required
Any of:
string format: date-time
nextRunAt
required
Any of:
string format: date-time
lastRun
required
Any of:
object
status
required
string
sizeBytes
required
Any of:
number
finishedAt
required
Any of:
string format: date-time
createdAt
required
string format: date-time
Example generated
{
  "id": "example",
  "serverId": "example",
  "databaseId": "example",
  "type": "example",
  "schedule": "example",
  "walArchive": true,
  "walSchedule": "example",
  "keepNewest": 1,
  "retentionDays": 1,
  "enabled": true,
  "lastWalAt": "2026-04-15T12:00:00Z",
  "nextRunAt": "2026-04-15T12:00:00Z",
  "lastRun": {
    "status": "example",
    "sizeBytes": 1,
    "finishedAt": "2026-04-15T12:00:00Z"
  },
  "createdAt": "2026-04-15T12:00:00Z"
}

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"
    }
  ]
}