Retrieve

Retrieve an Existing Firewall

get/v2/firewalls/{firewall_id}

To show information about an existing firewall, send a GET request to /v2/firewalls/$FIREWALL_ID.

Path Parameters

firewall_idstring

formatuuid

Returns

firewallidstringcreated_atstringdroplet_idsarray of numberinbound_rulesarray of objectnamestringoutbound_rulesarray of objectpending_changesarray of objectstatusenumtagsarray of stringFirewall

optional

HTTPPython

curl https://api.digitalocean.com//v2/firewalls/$FIREWALL_ID \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"

200 Example

{
  "firewall": {
    "droplet_ids": [
      8043964
    ],
    "inbound_rules": [
      {
        "ports": "8000",
        "protocol": "tcp",
        "sources": {
          "addresses": [
            "1.2.3.4",
            "18.0.0.0/8"
          ],
          "droplet_ids": [
            8043964
          ],
          "kubernetes_ids": [
            "41b74c5d-9bd0-5555-5555-a57c495b81a3"
          ],
          "load_balancer_uids": [
            "4de7ac8b-495b-4884-9a69-1050c6793cd6"
          ],
          "tags": [
            "base-image",
            "prod"
          ]
        }
      }
    ],
    "name": "firewall",
    "outbound_rules": [
      {
        "destinations": {
          "addresses": [
            "1.2.3.4",
            "18.0.0.0/8"
          ],
          "droplet_ids": [
            8043964
          ],
          "kubernetes_ids": [
            "41b74c5d-9bd0-5555-5555-a57c495b81a3"
          ],
          "load_balancer_uids": [
            "4de7ac8b-495b-4884-9a69-1050c6793cd6"
          ],
          "tags": [
            "base-image",
            "prod"
          ]
        },
        "ports": "8000",
        "protocol": "tcp"
      }
    ],
    "tags": [
      "base-image",
      "prod"
    ]
  }
}