Create and manage VPS backup schedules

Create and configure automatic backup schedules for your virtual servers (VMs). You can specify the time, how many copies to save, and whether the feature should be active. The endpoint returns an ID that can be used to reference the created schedule in future calls, which is important for managing and monitoring your backups.

Path Parameters

vmid integer · min: 1 required Example

Unique vmid identifier

Headers

Accept Example

Content-Type Example

Body

required

application/json

schedule_type string · enum required

daily

monthly

weekly

hour integer required

minute integer required

retention_count integer required

enabled boolean required

notes string required

day_of_week integer

day_of_month integer

Responses

200

success boolean

timestamp string

requestId string

data object

POST https://cloud.hostup.se/api/vm/{vmid}/backup-schedules

For AI assistants

cURL

curl -X POST "https://cloud.hostup.se/api/vm/5596/backup-schedules" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "schedule_type": "daily",
    "hour": 0,
    "minute": 0,
    "retention_count": 0,
    "enabled": true,
    "notes": "string",
    "day_of_week": 0,
    "day_of_month": 0
  }'

Response

{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "success": true,
    "schedule": {
      "id": 0,
      "client_id": "string",
      "account_id": "string",
      "vm_id": "string",
      "enabled": true,
      "schedule_type": "string",
      "hour": 0,
      "minute": 0,
      "day_of_week": 0,
      "day_of_month": "string",
      "retention_count": 0,
      "backup_mode": "string",
      "compress": "string",
      "notes": "string",
      "last_run": "string",
      "next_run": "string",
      "created_at": "string",
      "updated_at": "string"
    },
    "message": "string"
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "timestamp": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean"
        },
        "schedule": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "client_id": {
              "type": "string"
            },
            "account_id": {
              "type": "string"
            },
            "vm_id": {
              "type": "string"
            },
            "enabled": {
              "type": "boolean"
            },
            "schedule_type": {
              "type": "string"
            },
            "hour": {
              "type": "integer"
            },
            "minute": {
              "type": "integer"
            },
            "day_of_week": {
              "type": "integer"
            },
            "day_of_month": {
              "type": "string",
              "nullable": true
            },
            "retention_count": {
              "type": "integer"
            },
            "backup_mode": {
              "type": "string"
            },
            "compress": {
              "type": "string"
            },
            "notes": {
              "type": "string"
            },
            "last_run": {
              "type": "string",
              "nullable": true
            },
            "next_run": {
              "type": "string"
            },
            "created_at": {
              "type": "string"
            },
            "updated_at": {
              "type": "string"
            }
          }
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

Request Body

{
  "schedule_type": "daily",
  "hour": 0,
  "minute": 0,
  "retention_count": 0,
  "enabled": true,
  "notes": "string",
  "day_of_week": 0,
  "day_of_month": 0
}