Class FirewallService

Assign Droplets to a Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const dropletIds = [
   'droplet-id-1',
   'droplet-id-2'
];
await client.firewalls.addDropletsToFirewall('firewall-id', dropletIds);

Add additional access rules to a Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const inboundRules = [
  {
    "protocol": "tcp",
    "ports": "3306",
    "sources": {
      "droplet_ids": [
        49696269
      ]
    }
  }
];
outboundRules = [
  {
    "protocol": "tcp",
    "ports": "3306",
    "destinations": {
      "droplet_ids": [
        49696269
      ]
    }
  }
];
await client.firewalls.addRulesToFirewall('firewall-id', inboundRules, outboundRules);

Assign a Tag representing a group of Droplets to a Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const tags = [
   'my-tag-1',
   'my-tag-2'
];
await client.firewalls.addTagsToFirewall('firewall-id', tags);

Create a new Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const newFirewall = {
  "name": "firewall",
  "inbound_rules": [
    {
      "protocol": "tcp",
      "ports": "80",
      "sources": {
        "load_balancer_uids": [
          "4de7ac8b-495b-4884-9a69-1050c6793cd6"
        ]
      }
    },
    {
      "protocol": "tcp",
      "ports": 22,
      "sources": {
        "tags": [
          "gateway"
        ],
        "addresses": [
          "18.0.0.0/8"
        ]
      }
    }
  ],
  "outbound_rules": [
    {
      "protocol": "tcp",
      "ports": "80",
      "destinations": {
        "addresses": [
          "0.0.0.0/0",
          "::/0"
        ]
      }
    }
  ],
  "droplet_ids": [
    8043964
  ],
  "tags": null
};
const firewall = await client.firewalls.createFirewall(newFirewall);

Delete a Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
await client.firewalls.deleteFirewall('firewall-id');

List all of the Cloud Firewalls available on your account

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const firewall = await client.firewalls.getAllFirewalls();

Show information about an existing Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const firewall = await client.firewalls.getExistingFirewall('firewall-id');

Remove Droplets from a Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const dropletIds = [
   'droplet-id-1',
   'droplet-id-2'
];
await client.firewalls.removeDropletsFromFirewall('firewall-id', dropletIds);

Remove access rules from a Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const inboundRules = [
  {
    "protocol": "tcp",
    "ports": "3306",
    "sources": {
      "droplet_ids": [
        49696269
      ]
    }
  }
];
outboundRules = [
  {
    "protocol": "tcp",
    "ports": "3306",
    "destinations": {
      "droplet_ids": [
        49696269
      ]
    }
  }
];
await client.firewalls.removeRulesFromFirewall('firewall-id', inboundRules, outboundRules);

Remove a Tag representing a group of Droplets from a Cloud Firewall

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const tags = [
   'my-tag-1',
   'my-tag-2'
];
await client.firewalls.removeTagsFromFirewall('firewall-id', tags);

Update the configuration of an existing Cloud Firewall

NOTE: Any attributes that are not provided will be reset to their default values.

import { DigitalOcean } from 'digitalocean-js';

const client = new DigitalOcean('your-api-key');
const updatedFirewall = {
  "name": "firewall",
  "inbound_rules": [
    {
      "protocol": "tcp",
      "ports": "8080",
      "sources": {
        "load_balancer_uids": [
          "4de7ac8b-495b-4884-9a69-1050c6793cd6"
        ]
      }
    },
    {
      "protocol": "tcp",
      "ports": 22,
      "sources": {
        "tags": [
          "gateway"
        ],
        "addresses": [
          "18.0.0.0/8"
        ]
      }
    }
  ],
  "outbound_rules": [
    {
      "protocol": "tcp",
      "ports": "8080",
      "destinations": {
        "addresses": [
          "0.0.0.0/0",
          "::/0"
        ]
      }
    }
  ],
  "droplet_ids": [
    8043964
  ],
  "tags": [
    "frontend"
  ]
};
const firewall = await client.firewalls.updateFirewall(updatedFirewall);