listReservedIps
List Reserved IPs
Details
- Method:
GET - Path:
/reserved-ips - Operation ID:
list-reserved-ips
Parameters
{
"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": {
"reserved_ips": {
"type": "array",
"items": {
"title": "reserved-ip",
"type": "object",
"x-examples": {
"reserved ip": {
"id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60",
"region": "ewr",
"ip_type": "v6",
"subnet": "2001:db8:9999::",
"subnet_size": 64,
"label": "Example Reserved IPv6",
"instance_id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60"
}
},
"description": "Reserved IP information.",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the Reserved IP."
},
"region": {
"type": "string",
"description": "The [Region id](#operation/list-regions) where the Reserved IP is located."
},
"ip_type": {
"type": "string",
"description": "The type of IP address.\n\n* v4\n* v6"
},
"subnet": {
"type": "string",
"description": "The IP subnet."
},
"subnet_size": {
"type": "integer",
"description": "The IP network size in bits."
},
"label": {
"type": "string",
"description": "The user-supplied label."
},
"instance_id": {
"type": "string",
"description": "The [Instance id](#operation/list-instances) attached to this Reserved IP."
}
}
}
},
"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('listReservedIps', {
# Add required parameters here
})