listBackups
List Backups
Details
- Method:
GET - Path:
/backups - Operation ID:
list-backups
Parameters
{
"instance_id": {
"description": "Filter the backup list by [Instance id](#operation/list-instances).",
"required": false,
"location": "query",
"type": "string"
},
"per_page": {
"description": "Number of items requested per page. Default is 100 and Max is 500.",
"required": false,
"location": "query",
"type": "integer"
},
"cursor": {
"description": "Cursor for paging. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination).",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"type": "object",
"properties": {
"backups": {
"type": "array",
"items": {
"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"
]
}
},
"meta": {
"title": "meta",
"type": "object",
"x-examples": {
"meta response": {
"meta": {
"total": 31,
"links": {
"next": "WxYzExampleNext",
"prev": ""
}
}
}
},
"description": "The meta information object. See [Meta and Pagination](#section/Introduction/Meta-and-Pagination) for more information.",
"properties": {
"total": {
"type": "integer",
"description": "Total objects available in the list. This value may be greater than the number of objects returned if `per_page` is set."
},
"links": {
"type": "object",
"description": "Cursor values for pagination.",
"properties": {
"next": {
"type": "string",
"description": "Cursor value for the next page."
},
"prev": {
"type": "string",
"description": "Cursor value for the previous page."
}
}
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('vultr')
# Call this tool
result = await agent.call_tool('listBackups', {
# Add required parameters here
})