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

    Type Alias PutLinodeInterfaceData

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

    Properties

    body path query? url

    Properties

    body

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

    Modifies an existing Linode interface. The interface type (vpc, public, vlan) can't be changed.

    Type Declaration

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

        Defines whether IPv4 and IPv6 default routes are enabled for this interface. Public interfaces can have both an IPv4 and IPv6 default_route, provided they have at least one IP address of the corresponding type. If the default_route is omitted, (or set to null), no changes are made to the default_route configuration.

        • Optionalipv4?: boolean | null

          If set to true, and if the interface has at least one IPv4 address after the PUT request, the default_route role is assigned to the interface. If another interface is already configured as the default route, this setting removes that configuration. If the interface has an IPv4 address, the value cannot be set as false.

        • Optionalipv6?: boolean | null

          If set to true, and if the interface has at least one IPv6 address after the PUT request, the default_route role is assigned to the interface. If another interface is already configured as the default route, this setting removes that configuration. If the interface has an IPv6 address, the value cannot be set as false.

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

        Public interface settings.

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

        VLAN interface settings.

        • Optionalipam_address?: string | null

          This VLAN interface's private IPv4 address in classless inter-domain routing (CIDR) notation. The ipam_address can't be updated. It needs to be the existing value, or null.

        • Optionalvlan_label?: string

          The VLAN's label. Once you specify it, you can't update it.

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

        Indicates if the interface is used as the default route. A VPC interface can have an IPv4 default_route.

        • Optionalipv4?: boolean | null

          If set to true, and if the interface has at least one IPv4 address after the PUT request, the default_route role is assigned to the interface. If another interface is already configured as the default route, this setting removes that configuration. If the interface has an IPv4 address, the value can't be set to false. If this is omitted, or set to null, no changes are made to the interface's IPv4 configuration.

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

        VPC interface settings.

    path: { interfaceId: number; linodeId: number }

    Type Declaration

    • interfaceId: number

      The id of the Linode interface.

    • linodeId: number

      The id of the Linode.

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

    Settings

    Member Visibility

    On This Page

    Properties