Updating a Firewall Policy

Function

This API is used to update a firewall policy.

URI

PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id}

Request Parameters

Table 1 Request parameter

Parameter	Type	Mandatory	Description
firewall_policy	firewall_policy object	Yes	Specifies the firewall policy objects. For details, see Table 2.

Table 2 Firewall Policy objects

Attribute	Mandatory	Type	Description
name	No	String	Specifies the name of the firewall policy. The value can contain a maximum of 255 characters.
description	No	String	Provides supplementary information about the firewall policy. The value can contain a maximum of 255 characters.
firewall_rules	No	Array of strings	Specifies the firewall rules referenced by the firewall policy.
audited	No	Boolean	Specifies the audit flag. The value can be true or false.

Example Request

Associate the ACL policy whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a to the ACL rule whose ID is 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1.

PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a

{
    "firewall_policy": {
        "firewall_rules": [
            "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1"
        ]
    }
}

Response Parameters

Table 3 Response parameter

Parameter	Type	Description
firewall_policy	firewall_policy object	Specifies the firewall policy objects. For details, see Table 4.

Table 4 Firewall Policy objects

Attribute	Type	Description
id	String	Specifies the UUID of the firewall policy.
name	String	Specifies the name of the firewall policy.
description	String	Provides supplementary information about the firewall policy.
tenant_id	String	Specifies the project ID.
firewall_rules	Array of strings	Specifies the firewall rules referenced by the firewall policy.
audited	Boolean	Specifies the audit flag.
public	Boolean	Specifies whether the firewall policy can be shared by different tenants.
project_id	String	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Example Response

{
    "firewall_policy": {
        "description": "",
        "firewall_rules": [
            "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1"
        ],
        "tenant_id": "23c8a121505047b6869edf39f3062712",
        "public": false,
        "id": "2fb0e81f-9f63-44b2-9894-c13a3284594a",
        "audited": false,
        "name": "test-policy",
        "project_id": "23c8a121505047b6869edf39f3062712"
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

last updated: 2024-11-08 14:19 UTC - commit: 27016cc3b7ea2cc53f679bb1d813c3e7d534c8cc