{ "opencollection": "1.0.0", "info": { "name": "F5 BIG-IP iControl REST Nodes Virtual Servers API", "version": "15.1.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Virtual Servers", "type": "folder" }, "items": [ { "info": { "name": "List All Virtual Servers", "type": "http" }, "http": { "method": "GET", "url": "https://{bigip_host}/mgmt/tm/ltm/virtual", "params": [ { "name": "$select", "value": "name,destination,pool", "type": "query", "description": "Comma-separated list of property names to include in the response." }, { "name": "$filter", "value": "partition eq Common", "type": "query", "description": "OData filter expression to restrict returned resources." }, { "name": "$top", "value": "10", "type": "query", "description": "Maximum number of resources to return." }, { "name": "$skip", "value": "0", "type": "query", "description": "Number of resources to skip before returning results." }, { "name": "expandSubcollections", "value": "true", "type": "query", "description": "When set to true, expands all subcollections inline within the response." } ] }, "docs": "Returns a collection of all virtual server resources configured on the BIG-IP system." }, { "info": { "name": "Create a Virtual Server", "type": "http" }, "http": { "method": "POST", "url": "https://{bigip_host}/mgmt/tm/ltm/virtual", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new virtual server resource on the BIG-IP system. At minimum, a name and destination address:port must be specified." }, { "info": { "name": "Get a Virtual Server", "type": "http" }, "http": { "method": "GET", "url": "https://{bigip_host}/mgmt/tm/ltm/virtual/:virtualName", "params": [ { "name": "virtualName", "value": "my_virtual_server", "type": "path", "description": "Name of the virtual server resource. Use ~Common~ prefix for partition-qualified names (e.g., ~Common~my_virtual)." }, { "name": "expandSubcollections", "value": "true", "type": "query", "description": "When set to true, expands all subcollections inline within the response." } ] }, "docs": "Returns a single virtual server resource identified by name." }, { "info": { "name": "Update a Virtual Server", "type": "http" }, "http": { "method": "PUT", "url": "https://{bigip_host}/mgmt/tm/ltm/virtual/:virtualName", "params": [ { "name": "virtualName", "value": "my_virtual_server", "type": "path", "description": "Name of the virtual server resource. Use ~Common~ prefix for partition-qualified names (e.g., ~Common~my_virtual)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the entire virtual server resource. All writable properties must be included in the request body." }, { "info": { "name": "Patch a Virtual Server", "type": "http" }, "http": { "method": "PATCH", "url": "https://{bigip_host}/mgmt/tm/ltm/virtual/:virtualName", "params": [ { "name": "virtualName", "value": "my_virtual_server", "type": "path", "description": "Name of the virtual server resource. Use ~Common~ prefix for partition-qualified names (e.g., ~Common~my_virtual)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially updates a virtual server resource. Only specified properties are modified." }, { "info": { "name": "Delete a Virtual Server", "type": "http" }, "http": { "method": "DELETE", "url": "https://{bigip_host}/mgmt/tm/ltm/virtual/:virtualName", "params": [ { "name": "virtualName", "value": "my_virtual_server", "type": "path", "description": "Name of the virtual server resource. Use ~Common~ prefix for partition-qualified names (e.g., ~Common~my_virtual)." } ] }, "docs": "Removes a virtual server resource from the BIG-IP system. Active connections will be terminated." } ] } ], "bundled": true }