Type Alias ListGatewaysRequest

ListGatewaysRequest: {
    includeLegacy?: boolean;
    name?: string;
    orderBy?: VPCGW.v2.ListGatewaysRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    privateNetworkIds?: string[];
    projectId?: string;
    status?: VPCGW.v2.GatewayStatus[];
    tags?: string[];
    types?: string[];
    zone?: Zone;
}

Type declaration

  • OptionalincludeLegacy?: boolean

    Include also legacy gateways.

  • Optionalname?: string

    Filter for gateways which have this search term in their name.

  • OptionalorderBy?: VPCGW.v2.ListGatewaysRequestOrderBy

    Order in which to return results.

  • OptionalorganizationId?: string

    Include only gateways in this Organization.

  • Optionalpage?: number

    Page number to return.

  • OptionalpageSize?: number

    Gateways per page.

  • OptionalprivateNetworkIds?: string[]

    Filter for gateways attached to these Private Networks.

  • OptionalprojectId?: string

    Include only gateways in this Project.

  • Optionalstatus?: VPCGW.v2.GatewayStatus[]

    Filter for gateways with these status. Use unknown to include all statuses.

  • Optionaltags?: string[]

    Filter for gateways with these tags.

  • Optionaltypes?: string[]

    Filter for gateways of these types.

  • Optionalzone?: Zone

    Zone to target. If none is passed will use default zone from the config.

Settings