Virtual Routers

Allowed HTTP methods

Method Description
GET get / list object/s
POST create new object/s
PUT update / modify object/s
DELETE delete object/s

Note

See RFC 2616#section-9 for more details on HTTP methods semantics

Listing

GET /virtualrouters/

Gets the list of virtual routers to which the authenticated user has access.

Status Codes:

Example request:

Example response:

Detailed listing

GET /virtualrouters/detail/

Gets the detailed list of virtual routers to which the authenticated user has access.

Status Codes:

Example request:

Example response:

List single virtual router

GET /virtualrouters/{virtualrouter_uuid}/

Gets detailed information on the virtual router identified by virtualrouter_uuid.

Status Codes:

Example request:

Example response:

Creating

POST /virtualrouters/

Creates a new virtual router. The minimal amount of information you need to set is given below.

Status Codes:

Minimal virtual router configuration

Example request:

Example response:

More complex virtual router configuration

Example request:

Example response:

Editing

PUT /virtualrouters/{uuid}/

Edits a virtual router. Note that if a virtual router is running, only the field name can be changed, and all other changes to the definition of a running virtual router will be ignored.

Status Codes:

Example request:

Example response:

Deleting

Single virtual router

DELETE /virtualrouters/{virtualrouter_uuid}/

Deletes a single virtual router identified by virtualrouter_uuid.

Status Codes:

Example request:

Example response:

Enable Firewall

POST /virtualrouters/{virtualrouter_uuid}/action/?do=enable_firewall

Activates the firewall feature on a virtual router identified by virtualrouter_uuid.

Status Codes:

Example request:

Example response:

Disable Firewall

POST /virtualrouters/{virtualrouter_uuid}/action/?do=disable_firewall

Deactivates the firewall feature on a virtual router identified by virtualrouter_uuid. This will disable all the applied filters.

Status Codes:

Example request:

Example response:

Enable Firewall logging

POST /virtualrouters/{virtualrouter_uuid}/action/?do=enable_firewall_logging

Enables firewall logging for all active filters on a virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Disable Firewall logging

POST /virtualrouters/{virtualrouter_uuid}/action/?do=disable_firewall_logging

Disables firewall logging for all the active filters on a virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Enable NAT

POST /virtualrouters/{virtualrouter_uuid}/action/?do=enable_nat

Activates the NAT feature on a virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Disable NAT

POST /virtualrouters/{virtualrouter_uuid}/action/?do=disable_nat

Deactivates the NAT feature on a virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Enable VPN

POST /virtualrouters/{virtualrouter_uuid}/action/?do=enable_vpn

Activates the VPN feature on a virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Disable VPN

POST /virtualrouters/{virtualrouter_uuid}/action/?do=disable_vpn

Deactivates the VPN feature on a virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Get Log

POST /virtualrouters/{virtualrouter_uuid}/action/?do=get_log

Get the latest log entries on a virtual router identified by vrfwfilter_uuid. Valid log_name values that can be included in the query parameters are: system and firewall.

Status Codes:

Example request:

Example response:

Get Keys

POST /virtualrouters/{virtualrouter_uuid}/action/?do=get_keys

Get the keys related to virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Export key

POST /virtualrouters/{virtualrouter_uuid}/action/?do=export_key

Export the key identified by key_uuid of the virtual router identified by virtualrouter_uuid

Status Codes:

Example request:

Example response:

Schema