Type Alias ListDomainsRequest

ListDomainsRequest: {
    name?: string;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    projectId?: string;
    region?: Region;
    status?: TransactionalEmail.v1alpha1.DomainStatus[];
}

Type declaration

  • Optionalname?: string

    (Optional) Names of the domains to list.

  • OptionalorganizationId?: string

    (Optional) ID of the Organization in which to list the domains.

  • Optionalpage?: number

    Requested page number. Value must be greater or equal to 1.

  • OptionalpageSize?: number

    Requested page size. Value must be between 1 and 1000.

  • OptionalprojectId?: string

    (Optional) ID of the Project in which to list the domains.

  • Optionalregion?: Region

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

  • Optionalstatus?: TransactionalEmail.v1alpha1.DomainStatus[]

    (Optional) List domains under specific statuses.

Settings