Type Alias HostingApiListHostingsRequest

HostingApiListHostingsRequest: {
    controlPanels?: string[];
    domain?: string;
    orderBy?: ListHostingsRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    projectId?: string;
    region?: Region;
    statuses?: HostingStatus[];
    tags?: string[];
}

Type declaration

  • OptionalcontrolPanels?: string[]

    Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned.

  • Optionaldomain?: string

    Domain to filter for, only Web Hosting plans associated with this domain will be returned.

  • OptionalorderBy?: ListHostingsRequestOrderBy

    Sort order for Web Hosting plans in the response.

  • OptionalorganizationId?: string

    Organization ID to filter for, only Web Hosting plans from this Organization will be returned.

  • Optionalpage?: number

    Page number to return, from the paginated results (must be a positive integer).

  • OptionalpageSize?: number

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

  • OptionalprojectId?: string

    Project ID to filter for, only Web Hosting plans from this Project will be returned.

  • Optionalregion?: Region

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

  • Optionalstatuses?: HostingStatus[]

    Statuses to filter for, only Web Hosting plans with matching statuses will be returned.

  • Optionaltags?: string[]

    Tags to filter for, only Web Hosting plans with matching tags will be returned.

Settings