Type Alias OfferApiListOffersRequest

OfferApiListOffersRequest: {
    controlPanels?: string[];
    hostingId?: string;
    orderBy?: Webhosting.v1.ListOffersRequestOrderBy;
    page?: number;
    pageSize?: number;
    region?: Region;
}

Type declaration

  • OptionalcontrolPanels?: string[]

    Name of the control panel(s) to filter for.

  • OptionalhostingId?: string

    UUID of the hosting plan.

  • OptionalorderBy?: Webhosting.v1.ListOffersRequestOrderBy

    Sort order for Web Hosting offers in the response.

  • Optionalpage?: number

    Page number (must be a positive integer).

  • OptionalpageSize?: number

    Number of websites to return (must be a positive integer lower or equal to 100).

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

Settings