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

    Type Alias PostLinodeInterfaceData

    type PostLinodeInterfaceData = {
        body?:
            | {
                default_route?: { ipv4?: boolean
                | null; ipv6?: boolean | null };
                firewall_id?: number | null;
                public?:
                    | {
                        ipv4?: {
                            addresses?: {
                                address?: string
                                | "auto"
                                | string;
                                primary?: boolean;
                            }[];
                        };
                        ipv6?: { ranges?: { range: string }[] };
                    }
                    | null;
            }
            | { vlan?: { ipam_address?: string; vlan_label?: string }
            | null }
            | {
                default_route?: { ipv4?: boolean | null };
                firewall_id?: number | null;
                vpc?:
                    | {
                        ipv4?: {
                            addresses?: {
                                address?: string
                                | "auto";
                                nat_1_1_address?: string | "auto" | null;
                                primary?: boolean | null;
                            }[];
                            ranges?: { range: string }[];
                        };
                        subnet_id: number;
                    }
                    | null;
            };
        path: { linodeId: number };
        query?: never;
        url: "linode/instances/{linodeId}/interfaces";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?:
        | {
            default_route?: { ipv4?: boolean
            | null; ipv6?: boolean | null };
            firewall_id?: number | null;
            public?:
                | {
                    ipv4?: {
                        addresses?: {
                            address?: string
                            | "auto"
                            | string;
                            primary?: boolean;
                        }[];
                    };
                    ipv6?: { ranges?: { range: string }[] };
                }
                | null;
        }
        | { vlan?: { ipam_address?: string; vlan_label?: string }
        | null }
        | {
            default_route?: { ipv4?: boolean | null };
            firewall_id?: number | null;
            vpc?:
                | {
                    ipv4?: {
                        addresses?: {
                            address?: string
                            | "auto";
                            nat_1_1_address?: string | "auto" | null;
                            primary?: boolean | null;
                        }[];
                        ranges?: { range: string }[];
                    };
                    subnet_id: number;
                }
                | null;
        }

    Defines Linode interfaces. You can configure interfaces for one of the following types: vpc, public, or vlan. Any other type must either be omitted or set to null.

    Type Declaration

    • {
          default_route?: { ipv4?: boolean | null; ipv6?: boolean | null };
          firewall_id?: number | null;
          public?:
              | {
                  ipv4?: {
                      addresses?: { address?: string
                      | "auto"
                      | string; primary?: boolean }[];
                  };
                  ipv6?: { ranges?: { range: string }[] };
              }
              | null;
      }
      • Optionaldefault_route?: { ipv4?: boolean | null; ipv6?: boolean | null }

        Indicates if the interface serves as the default route when multiple interfaces are eligible for this role. A public interface can have both an IPv4 default_route and an IPv6 default_route, provided it has at least one IP address of the corresponding type.

        • Optionalipv4?: boolean | null

          If set to true, the interface is used for the IPv4 default_route. Only one interface per Linode can be set as the IPv4 default route.

        • Optionalipv6?: boolean | null

          If set to true, the interface is used for the IPv6 default_route. Only one interface per Linode can have the IPv6 default route.

      • Optionalfirewall_id?: number | null

        The enabled firewall to secure a VPC or public interface. Not allowed for VLAN interfaces. If a firewall_id is not provided for a VPC or a public interface, then its default interface firewall is used. If a default firewall is not available, and null is not specified, the request fails. Setting the firewall_id as null indicates that no firewall device will be attached to the interface.

      • Optionalpublic?:
            | {
                ipv4?: {
                    addresses?: { address?: string
                    | "auto"
                    | string; primary?: boolean }[];
                };
                ipv6?: { ranges?: { range: string }[] };
            }
            | null

        Public interface settings. A Linode can have only one public interface. A public interface can have both IPv4 and IPv6 configurations.

    • { vlan?: { ipam_address?: string; vlan_label?: string } | null }
      • Optionalvlan?: { ipam_address?: string; vlan_label?: string } | null

        VLAN interface settings. A Linode can have up to three VLAN interfaces, with a unique vlan_label for each.

    • {
          default_route?: { ipv4?: boolean | null };
          firewall_id?: number | null;
          vpc?:
              | {
                  ipv4?: {
                      addresses?: {
                          address?: string
                          | "auto";
                          nat_1_1_address?: string | "auto" | null;
                          primary?: boolean | null;
                      }[];
                      ranges?: { range: string }[];
                  };
                  subnet_id: number;
              }
              | null;
      }
      • Optionaldefault_route?: { ipv4?: boolean | null }

        Indicates if the interface is used as the default route when multiple interfaces are eligible for this role. A VPC interface can have an IPv4 default_route.

        • Optionalipv4?: boolean | null

          If set to true, the interface is used for the IPv4 default_route. Only one interface per Linode can be set as the IPv4 default route.

      • Optionalfirewall_id?: number | null

        The enabled firewall to secure a VPC or public interface. Not allowed for VLAN interfaces. If a firewall_id is not provided for a VPC or a public interface, then its default interface firewall is used. If a default firewall is not available, and null is not specified, the request fails. Setting the firewall_id as null indicates that no firewall device will be attached to the interface.

      • Optionalvpc?:
            | {
                ipv4?: {
                    addresses?: {
                        address?: string
                        | "auto";
                        nat_1_1_address?: string | "auto" | null;
                        primary?: boolean | null;
                    }[];
                    ranges?: { range: string }[];
                };
                subnet_id: number;
            }
            | null

        VPC interface settings. A Linode can have one VPC interface. The maximum number of interfaces allowed on a Linode is three.

    path: { linodeId: number }

    Type Declaration

    • linodeId: number

      The id of the Linode.

    query?: never
    url: "linode/instances/{linodeId}/interfaces"

    Settings

    Member Visibility

    On This Page

    Properties