backup

POST`/backup.create`

backup-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

Minimum length: 1

`destinationId`
Required
string

`database`
Required
string

Minimum length: 1

`mariadbId`string | null

`mysqlId`string | null

`postgresId`string | null

`mongoId`string | null

`databaseType`
Required
string

Value in: "postgres" | "mariadb" | "mysql" | "mongo"

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/backup.create" \
  -d '{
  "schedule": "string",
  "enabled": true,
  "prefix": "string",
  "destinationId": "string",
  "database": "string",
  "mariadbId": "string",
  "mysqlId": "string",
  "postgresId": "string",
  "mongoId": "string",
  "databaseType": "postgres"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET`/backup.one`

backup-one

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`backupId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/backup.one?backupId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/backup.update`

backup-update

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

Minimum length: 1

`backupId`
Required
string

`destinationId`
Required
string

`database`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/backup.update" \
  -d '{
  "schedule": "string",
  "enabled": true,
  "prefix": "string",
  "backupId": "string",
  "destinationId": "string",
  "database": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/backup.remove`

backup-remove

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`backupId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/backup.remove" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/backup.manualBackupPostgres`

backup-manualBackupPostgres

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`backupId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/backup.manualBackupPostgres" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/backup.manualBackupMySql`

backup-manualBackupMySql

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`backupId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/backup.manualBackupMySql" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/backup.manualBackupMariadb`

backup-manualBackupMariadb

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`backupId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/backup.manualBackupMariadb" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/backup.manualBackupMongo`

backup-manualBackupMongo

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`backupId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/backup.manualBackupMongo" \
  -d '{
  "backupId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

backup

POST/backup.create

AuthorizationRequiredBearer <token>

scheduleRequiredstring

enabledboolean | null

prefixRequiredstring

destinationIdRequiredstring

databaseRequiredstring

mariadbIdstring | null

mysqlIdstring | null

postgresIdstring | null

mongoIdstring | null

databaseTypeRequiredstring

Response

Typescript

GET/backup.one

AuthorizationRequiredBearer <token>

backupIdRequiredstring

Response

Typescript

POST/backup.update

AuthorizationRequiredBearer <token>

scheduleRequiredstring

enabledboolean | null

prefixRequiredstring

backupIdRequiredstring

destinationIdRequiredstring

databaseRequiredstring

Response

Typescript

POST/backup.remove

AuthorizationRequiredBearer <token>

backupIdRequiredstring

Response

Typescript

POST/backup.manualBackupPostgres

AuthorizationRequiredBearer <token>

backupIdRequiredstring

Response

Typescript

POST/backup.manualBackupMySql

AuthorizationRequiredBearer <token>

backupIdRequiredstring

Response

Typescript

POST/backup.manualBackupMariadb

AuthorizationRequiredBearer <token>

backupIdRequiredstring

Response

Typescript

POST/backup.manualBackupMongo

AuthorizationRequiredBearer <token>

backupIdRequiredstring

Response

Typescript

On this page

POST`/backup.create`

`Authorization`
Required
Bearer <token>

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

`destinationId`
Required
string

`database`
Required
string

`mariadbId`string | null

`mysqlId`string | null

`postgresId`string | null

`mongoId`string | null

`databaseType`
Required
string

GET`/backup.one`

`Authorization`
Required
Bearer <token>

`backupId`
Required
string

POST`/backup.update`

`Authorization`
Required
Bearer <token>

`schedule`
Required
string

`enabled`boolean | null

`prefix`
Required
string

`backupId`
Required
string

`destinationId`
Required
string

`database`
Required
string

POST`/backup.remove`

`Authorization`
Required
Bearer <token>

`backupId`
Required
string

POST`/backup.manualBackupPostgres`

`Authorization`
Required
Bearer <token>

`backupId`
Required
string

POST`/backup.manualBackupMySql`

`Authorization`
Required
Bearer <token>

`backupId`
Required
string

POST`/backup.manualBackupMariadb`

`Authorization`
Required
Bearer <token>

`backupId`
Required
string

POST`/backup.manualBackupMongo`

`Authorization`
Required
Bearer <token>

`backupId`
Required
string