Type Alias ListGatewaysRequest

ListGatewaysRequest: {
    name?: string;
    orderBy?: ListGatewaysRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    privateNetworkId?: string;
    projectId?: string;
    status?: GatewayStatus;
    tags?: string[];
    type?: string;
    zone?: Zone;
}

Type declaration

  • Optionalname?: string

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

  • OptionalorderBy?: 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.

  • OptionalprivateNetworkId?: string

    Filter for gateways attached to this Private nNetwork.

  • OptionalprojectId?: string

    Include only gateways in this Project.

  • Optionalstatus?: GatewayStatus

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

  • Optionaltags?: string[]

    Filter for gateways with these tags.

  • Optionaltype?: string

    Filter for gateways of this type.

  • Optionalzone?: Zone

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

Settings