getBackup
Get a Backup
Details
- Method:
GET - Path:
/backups/{backup-id} - Operation ID:
get-backup
Parameters
{}Response Schema
{
"type": "object",
"properties": {
"backup": {
"title": "backup",
"type": "object",
"x-examples": {
"backup": {
"id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60",
"date_created": "2020-10-10T01:56:20+00:00",
"description": "Example Automatic Backup",
"size": 10000000,
"status": "complete"
}
},
"description": "Backup information.",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the backup."
},
"date_created": {
"type": "string",
"description": "The date the backup was created."
},
"description": {
"type": "string",
"description": "The user-supplied description of this backup."
},
"size": {
"type": "integer",
"description": "The size of the backup in Bytes."
},
"status": {
"type": "string",
"description": "The Backup status.\n\n* complete\n* pending"
}
},
"x-tags": [
"backup"
]
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('vultr')
# Call this tool
result = await agent.call_tool('getBackup', {
# Add required parameters here
})