@akamai/openapi-ts
    Preparing search index...

    Type Alias PutFirewallRulesResponses

    type PutFirewallRulesResponses = {
        "200": {
            fingerprint: string;
            inbound: {
                action: "ACCEPT" | "DROP";
                addresses: { ipv4: string[]; ipv6: string[] };
                description: string;
                label: string;
                ports: string | null;
                protocol: "TCP" | "UDP" | "ICMP" | "IPENCAP";
            }[];
            inbound_policy: "ACCEPT"
            | "DROP";
            outbound: {
                action: "ACCEPT" | "DROP";
                addresses: { ipv4: string[]; ipv6: string[] };
                description: string;
                label: string;
                ports: string | null;
                protocol: "TCP" | "UDP" | "ICMP" | "IPENCAP";
            }[];
            outbound_policy: "ACCEPT"
            | "DROP";
            version: number;
        };
    }
    Index

    Properties

    Properties

    "200": {
        fingerprint: string;
        inbound: {
            action: "ACCEPT" | "DROP";
            addresses: { ipv4: string[]; ipv6: string[] };
            description: string;
            label: string;
            ports: string | null;
            protocol: "TCP" | "UDP" | "ICMP" | "IPENCAP";
        }[];
        inbound_policy: "ACCEPT"
        | "DROP";
        outbound: {
            action: "ACCEPT" | "DROP";
            addresses: { ipv4: string[]; ipv6: string[] };
            description: string;
            label: string;
            ports: string | null;
            protocol: "TCP" | "UDP" | "ICMP" | "IPENCAP";
        }[];
        outbound_policy: "ACCEPT"
        | "DROP";
        version: number;
    }

    The inbound and outbound access rules to apply to the Firewall.

    A Firewall may have up to 25 rules across its inbound and outbound rulesets.

    Multiple rules are applied in order. If two rules conflict, the first rule takes precedence. For example, if the first rule accepts inbound traffic from an address, and the second rule drops inbound traffic the same address, the first rule applies and inbound traffic from that address is accepted.

    Type Declaration

    • Readonlyfingerprint: string

      Read-only The fingerprint is a 32-bit hash. It represents the firewall rules as an 8 character hex string. You can use fingerprint to compare rule versions.

    • inbound: {
          action: "ACCEPT" | "DROP";
          addresses: { ipv4: string[]; ipv6: string[] };
          description: string;
          label: string;
          ports: string | null;
          protocol: "TCP" | "UDP" | "ICMP" | "IPENCAP";
      }[]

      The inbound rules for the firewall, as a JSON array.

    • inbound_policy: "ACCEPT" | "DROP"

      The default behavior for inbound traffic. This setting can be overridden by updating the inbound.action property of the Firewall Rule.

    • outbound: {
          action: "ACCEPT" | "DROP";
          addresses: { ipv4: string[]; ipv6: string[] };
          description: string;
          label: string;
          ports: string | null;
          protocol: "TCP" | "UDP" | "ICMP" | "IPENCAP";
      }[]

      The outbound rules for the firewall, as a JSON array.

    • outbound_policy: "ACCEPT" | "DROP"

      The default behavior for outbound traffic. This setting can be overridden by updating the outbound.action property of the Firewall Rule.

    • Readonlyversion: number

      Read-only The firewall's rule version. The first version is 1. The version number is incremented when the firewall's rules change.