Create firewall

Creates a firewall.

URI

/v2.0/fw/firewalls

HTTP method

POST

Request parameter

Key Description Type Required/optional
admin_state_up Administrative state of the firewall. If false (down), firewall does not forward packets and will drop all traffic to/from VMs behind the firewall. xsd:bool Optional
firewall_policy_id The firewall policy uuid that this firewall is associated with. This firewall will implement the rules contained in the firewall policy represented by this uuid. csapi:uuid Required
router_id The ID of the router that this firewall be applied.

If you do not specify this, the resource will be created at all routers in the project.

xsd:string Optional
Description Human readable description for the firewall (255 character limit). xsd:string Optional
name Human readable name for the firewall (255 character limit). Does not have to be unique. xsd:string Optional
availability_zone The Availability Zone name.

If you do not specify this, the resource will be created in the default Availability Zone.

xsd:string Optional

Example request


{
    "firewall": {
        "admin_state_up": true,
        "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
        "router_id": "fe00194c-d73c-4b46-b94a-622bf28fc9e2",
        "availability_zone": "AZ1"
    }
}
     

Response status

Status code Description
201 Normal response codes
itemNotFound (404) Error response codes
forbidden (403) Error response codes
Bad Request (400) Error response codes
Unauthorized (401) Error response codes

Response body (normal status)


{
    "firewall": {
        "admin_state_up": true,
        "description": "",
        "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
        "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
        "name": "",
        "status": "PENDING_CREATE",
        "tenant_id": "45977fa2dbd7482098dd68d0d8970117",
        "router_id": "fe00194c-d73c-4b46-b94a-622bf28fc9e2",
        "availability_zone": "AZ1"
    }
}
     

Description of response body (normal status)

Item Description
admin_state_up Administrative state of the firewall. If false (down), firewall does not forward packets and will drop all traffic to/from VMs behind the firewall.
Description Human readable description for the firewall (1024 character limit).
firewall_policy_id The firewall policy uuid that this firewall is associated with. This firewall will implement the rules contained in the firewall policy represented by this uuid.
id Unique identifier for the firewall object.
name Human readable name for the firewall (255 character limit). Does not have to be unique.
status Indicates whether firewall resource is currently operational. Possible values include: ACTIVE, DOWN, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
tenant_id Owner of the firewall. Only admin users can specify a project identifier other than their own.
router_id The ID of the router that this firewall applied.
availability_zone The Availability Zone name.