PUT /v2/firewalls/{firewall_id}
To update the configuration of an existing firewall, send a PUT request to
/v2/firewalls/$FIREWALL_ID. The request should contain a full representation
of the firewall including existing attributes. Note that any attributes that
are not provided will be reset to their default values.
Servers
- https://api.digitalocean.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
firewall_id |
String | Yes |
A unique ID that can be used to identify and reference a firewall. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
A unique ID that can be used to identify and reference a firewall. |
pending_changes[] |
Array | No |
An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied. |
pending_changes[].droplet_id |
Integer | No | |
pending_changes[].removing |
Boolean | No | |
pending_changes[].status |
String | No | |
name |
String | Yes |
A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-). |
tags[] |
Array | No |
An array containing the names of the Tags assigned to the firewall. |
droplet_ids[] |
Array | No |
An array containing the IDs of the Droplets assigned to the firewall. |
status |
String | No |
A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed". Possible values:
|
created_at |
String | No |
A time value given in ISO8601 combined date and time format that represents when the firewall was created. |
outbound_rules[] |
Array | No | |
outbound_rules[].protocol |
String | Yes |
The type of traffic to be allowed. This may be one of Possible values:
|
outbound_rules[].ports |
String | Yes |
The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. "8000-9000"), or "0" when all ports are open for a protocol. For ICMP rules this parameter will always return "0". |
inbound_rules[] |
Array | No | |
inbound_rules[].protocol |
String | Yes |
The type of traffic to be allowed. This may be one of Possible values:
|
inbound_rules[].ports |
String | Yes |
The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. "8000-9000"), or "0" when all ports are open for a protocol. For ICMP rules this parameter will always return "0". |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.