Open Context Protocol is live! 🚀 Read the launch post
getInstanceBackupSchedule

getInstanceBackupSchedule

Get Instance Backup Schedule

Details

  • Method: GET
  • Path: /instances/{instance-id}/backup-schedule
  • Operation ID: get-instance-backup-schedule

Parameters

{}

Response Schema

{
  "type": "object",
  "properties": {
    "backup_schedule": {
      "title": "backup-schedule",
      "type": "object",
      "x-tags": [
        "backup-schedule"
      ],
      "description": "Backup schedule information.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Indicates if backup is enabled:\n\n* true\n* false"
        },
        "type": {
          "type": "string",
          "description": "Type of backup schedule:\n\n|   | Value | Description |\n| - | ------ | ------------- |\n|   | daily | Back up once per day at `hour`. |\n|   | weekly | Back up once per week on `dow` at `hour`. |\n|   | monthly | Back up each month at `dom` at `hour`. |\n|   | daily\\_alt\\_even | Back up on even dates at `hour`. |\n|   | daily\\_alt\\_odd | Back up on odd dates at `hour`. |"
        },
        "next_scheduled_time_utc": {
          "type": "string",
          "description": "Time of next backup run in UTC."
        },
        "hour": {
          "type": "integer",
          "description": "Scheduled hour of day in UTC."
        },
        "dow": {
          "description": "Day of week to run.\n\n|   | Value | Description |\n| - | ------ | ------------- |\n|   | 1 | Sunday |\n|   | 2 | Monday |\n|   | 3 | Tuesday |\n|   | 4 | Wednesday |\n|   | 5 | Thursday |\n|   | 6 | Friday |\n|   | 7 | Saturday |",
          "type": "integer"
        },
        "dom": {
          "description": "Day of month to run. Use values between 1 and 28.",
          "type": "integer"
        }
      }
    }
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('vultr')

# Call this tool
result = await agent.call_tool('getInstanceBackupSchedule', {
    # Add required parameters here
})