listFirewallGroups
List Firewall Groups
Details
- Method:
GET - Path:
/firewalls - Operation ID:
list-firewall-groups
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": {
"firewall_groups": {
"type": "array",
"items": {
"title": "firewall-group",
"type": "object",
"x-tags": [
"firewall"
],
"x-examples": {
"group": {
"id": "cb676a46-66fd-4dfb-b839-443f2e6c0b60",
"description": "Example Firewall Group",
"date_created": "2020-10-10T01:56:20+00:00",
"date_modified": "2020-10-10T01:59:20+00:00",
"instance_count": 2,
"rule_count": 2,
"max_rule_count": 50
}
},
"description": "Firewall Group information.",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the Firewall Group."
},
"description": {
"type": "string",
"description": "User-supplied description of this Firewall Group."
},
"date_created": {
"type": "string",
"description": "Date the Firewall Group was originally created."
},
"date_modified": {
"type": "string",
"description": "Date of the last modification to this Firewall Group."
},
"instance_count": {
"type": "integer",
"description": "The number of instances linked to this Firewall Group."
},
"rule_count": {
"type": "integer",
"description": "The number of rules in this Firewall Group."
},
"max_rule_count": {
"type": "integer",
"description": "The maximum number of rules allowed for this Firewall Group."
}
}
}
},
"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('listFirewallGroups', {
# Add required parameters here
})