List

API Reference

GPU Droplets

Firewalls

List All Firewalls

gpu_droplets.firewalls.list(FirewallListParams**kwargs) -> FirewallListResponse

get/v2/firewalls

To list all of the firewalls available on your account, send a GET request to /v2/firewalls.

ParametersExpand Collapse

page: Optional[int]

Which 'page' of paginated results to return.

minimum1

per_page: Optional[int]

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

class FirewallListResponse: …

meta: MetaProperties

Information about the response itself.

total: Optional[int]

Number of objects returned by the request.

firewalls: Optional[List[Firewall]]

id: Optional[str]

A unique ID that can be used to identify and reference a firewall.

created_at: Optional[datetime]

A time value given in ISO8601 combined date and time format that represents when the firewall was created.

formatdate-time

droplet_ids: Optional[List[int]]

An array containing the IDs of the Droplets assigned to the firewall.

Requires droplet:read scope.

inbound_rules: Optional[List[InboundRule]]

ports: str

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".

protocol: Literal["tcp", "udp", "icmp"]

The type of traffic to be allowed. This may be one of tcp, udp, or icmp.

Accepts one of the following:

"tcp"

"udp"

"icmp"

sources: FirewallRuleTarget

An object specifying locations from which inbound traffic will be accepted.

addresses: Optional[List[str]]

An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the firewall will allow traffic.

droplet_ids: Optional[List[int]]

An array containing the IDs of the Droplets to which the firewall will allow traffic.

kubernetes_ids: Optional[List[str]]

An array containing the IDs of the Kubernetes clusters to which the firewall will allow traffic.

load_balancer_uids: Optional[List[str]]

An array containing the IDs of the load balancers to which the firewall will allow traffic.

tags: Optional[List[str]]

A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.

Requires tag:create and tag:read scopes.

name: Optional[str]

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 (-).

outbound_rules: Optional[List[OutboundRule]]

destinations: FirewallRuleTarget

An object specifying locations to which outbound traffic that will be allowed.

addresses: Optional[List[str]]

An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the firewall will allow traffic.

droplet_ids: Optional[List[int]]

An array containing the IDs of the Droplets to which the firewall will allow traffic.

kubernetes_ids: Optional[List[str]]

An array containing the IDs of the Kubernetes clusters to which the firewall will allow traffic.

load_balancer_uids: Optional[List[str]]

An array containing the IDs of the load balancers to which the firewall will allow traffic.

tags: Optional[List[str]]

A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.

Requires tag:create and tag:read scopes.

ports: str

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".

protocol: Literal["tcp", "udp", "icmp"]

The type of traffic to be allowed. This may be one of tcp, udp, or icmp.

Accepts one of the following:

"tcp"

"udp"

"icmp"

pending_changes: Optional[List[PendingChange]]

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.

droplet_id: Optional[int]

removing: Optional[bool]

status: Optional[str]

status: Optional[Literal["waiting", "succeeded", "failed"]]

A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed".

Accepts one of the following:

"waiting"

"succeeded"

"failed"

tags: Optional[List[str]]

A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.

Requires tag:create and tag:read scopes.

links: Optional[PageLinks]

pages: Optional[Pages]

Accepts one of the following:

class ForwardLinks: …

last: Optional[str]

URI of the last page of the results.

next: Optional[str]

URI of the next page of the results.

class BackwardLinks: …

first: Optional[str]

URI of the first page of the results.

prev: Optional[str]

URI of the previous page of the results.

PagesUnionMember2 = object

List All Firewalls

python

• http
• typescript
• python

from gradient import Gradient

client = Gradient(
    access_token="My Access Token",
)
firewalls = client.gpu_droplets.firewalls.list()
print(firewalls.meta)

200 example

{
  "meta": {
    "total": 1
  },
  "firewalls": [
    {
      "id": "bb4b2611-3d72-467b-8602-280330ecd65c",
      "created_at": "2020-05-23T21:24:00Z",
      "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"
        }
      ],
      "pending_changes": [
        {
          "droplet_id": 8043964,
          "removing": false,
          "status": "waiting"
        }
      ],
      "status": "waiting",
      "tags": [
        "base-image",
        "prod"
      ]
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}

Returns Examples

200 example

{
  "meta": {
    "total": 1
  },
  "firewalls": [
    {
      "id": "bb4b2611-3d72-467b-8602-280330ecd65c",
      "created_at": "2020-05-23T21:24:00Z",
      "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"
        }
      ],
      "pending_changes": [
        {
          "droplet_id": 8043964,
          "removing": false,
          "status": "waiting"
        }
      ],
      "status": "waiting",
      "tags": [
        "base-image",
        "prod"
      ]
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}