Firewall Interface

This page describes operations you can perform on firewall_interfaces. List, get details for, and update.

List Firewall Interface

List all visible firewall_interfaces.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/firewall_interfaces

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
description query string - - Description the Firewall Interface no
firewall_id query string hyph-uuid - The ID of firewall this firewall_interface belongs to. no
id query string uuid - Unique ID of the Firewall Interface no
ip_address query string ipv4 - IP Address no
name query string - - Name the Firewall Interface no
network_id query string hyph-uuid - Network no
slot_number query integer - - Slot Number no
status query string - - Firewall interface status no
tenant_id query string uuid - Tenant ID of the owner (UUID) no
virtual_ip_address query string ipv4 - Virtual IP Address no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
firewall_interfaces array<object> Firewall Interface -
description string - Description the Firewall Interface
firewall_id string hyph-uuid The ID of firewall this firewall_interface belongs to.
id string uuid Unique ID of the Firewall Interface
ip_address string ipv4 IP Address
name string - Name the Firewall Interface
network_id string hyph-uuid Network
slot_number integer - Slot Number
status string - Firewall interface status
tenant_id string uuid Tenant ID of the owner (UUID)
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "firewall_interfaces": [
    {
      "description": "test",
      "firewall_id": "9f872504-36ab-46af-83ce-a4991c669edd",
      "id": "2897f333-3554-4099-a638-64d7022bf9ae",
      "ip_address": "100.64.64.99",
      "name": "dp0s5",
      "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
      "slot_number": 2,
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "virtual_ip_address": "100.64.64.100",
      "virtual_ip_properties": {
        "protocol": "vrrp",
        "vrid": 10
      }
    },
    {
      "description": "test",
      "firewall_id": "d80df2f1-75c9-49b9-bad1-31211b9c70a5",
      "id": "2b8c696e-0b86-4111-ad9a-bb4c4e166791",
      "ip_address": null,
      "name": "dp0s4",
      "network_id": null,
      "slot_number": 1,
      "status": "DOWN",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "virtual_ip_address": null,
      "virtual_ip_properties": null
    }
  ]
}

Show Firewall Interface

Show details for firewall_interface.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/firewall_interfaces/{firewall_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
firewall_interface_id URI string hyph-uuid - Unique ID of the Firewall Interface yes

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
firewall_interface object Firewall Interface -
description string - Description the Firewall Interface
firewall_id string hyph-uuid The ID of firewall this firewall_interface belongs to.
id string uuid Unique ID of the Firewall Interface
ip_address string ipv4 IP Address
name string - Name the Firewall Interface
network_id string hyph-uuid Network
slot_number integer - Slot Number
status string - Firewall interface status
tenant_id string uuid Tenant ID of the owner (UUID)
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "firewall_interface": {
    "description": "test",
    "firewall_id": "9f872504-36ab-46af-83ce-a4991c669edd",
    "id": "2897f333-3554-4099-a638-64d7022bf9ae",
    "ip_address": "100.64.64.99",
    "name": "dp0s5",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "slot_number": 2,
    "status": "ACTIVE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "virtual_ip_address": "100.64.64.100",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}

Update Firewall Interface

Update firewall_interface.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/v2.0/firewall_interfaces/{firewall_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
firewall_interface_id URI string hyph-uuid - Unique ID of the Firewall Interface yes
firewall_interface plain object Firewall Interface - - yes
description plain string - - Description the Firewall Interface no
ip_address plain string ipv4 - IP Address no
name plain string - - Name the Firewall Interface no
network_id plain string hyph-uuid - Network no
virtual_ip_address plain string ipv4 - Virtual IP Address no
virtual_ip_properties plain object - - Properties used for virtual IP address no
virtual_ip_properties.protocol plain string - [‘vrrp’] Redundancy Protocol no
virtual_ip_properties.vrid plain integer - - VRRP group identifier no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
409 Conflict
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
firewall_interface object Firewall Interface -
description string - Description the Firewall Interface
firewall_id string hyph-uuid The ID of firewall this firewall_interface belongs to.
id string uuid Unique ID of the Firewall Interface
ip_address string ipv4 IP Address
name string - Name the Firewall Interface
network_id string hyph-uuid Network
slot_number integer - Slot Number
status string - Firewall interface status
tenant_id string uuid Tenant ID of the owner (UUID)
virtual_ip_address string ipv4 Virtual IP Address
virtual_ip_properties object - Properties used for virtual IP address
protocol string - Redundancy Protocol
vrid integer - VRRP group identifier

Examples

Sample Request Body

{
  "firewall_interface": {
    "description": "test",
    "ip_address": "100.64.64.99",
    "name": "dp0s5",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "virtual_ip_address": "100.64.64.100",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}

Sample Response Body

{
  "firewall_interface": {
    "description": "test",
    "firewall_id": "9f872504-36ab-46af-83ce-a4991c669edd",
    "id": "2897f333-3554-4099-a638-64d7022bf9ae",
    "ip_address": "100.64.64.99",
    "name": "dp0s5",
    "network_id": "e6106a35-d79b-44a3-bda0-6009b2f8775a",
    "slot_number": 2,
    "status": "PENDING_UPDATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "virtual_ip_address": "100.64.64.100",
    "virtual_ip_properties": {
      "protocol": "vrrp",
      "vrid": 10
    }
  }
}