allowlist

allowlist

DomoAllowlist dataclass

DomoAllowlist(
    auth: DomoAuth,
    allowlist: list[str] = list(),
    is_filter_all_traffic_enabled: bool | None = None,
    raw: dict = dict(),
)

A class for managing the Domo instance IP allowlist configuration.

This class provides methods to get, set, add, and remove IP addresses/CIDR ranges from the instance allowlist, as well as manage the filter all traffic setting.

Note: Unlike most Domo entities, the allowlist is a singleton configuration per instance and does not have an 'id' field.

display_url property

display_url: str

Return the URL to the allowlist configuration page in Domo.

add_ips async

add_ips(
    ip_address_ls: str,
    is_suppress_errors: bool = False,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> list[str]

adds an IP or CIDR to the allowlist

Source code in src/crew_dcs/classes/DomoInstanceConfig/allowlist.py

async def add_ips(
    self,
    ip_address_ls: str,
    is_suppress_errors: bool = False,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> list[str]:
    """
    adds an IP or CIDR to the allowlist
    """
    base_context = RouteContext.build_context(
        session=session,
        debug_api=debug_api,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )
    context = RouteContext.build_context(context=context or base_context)

    new_allowlist = await self.get(context=context)

    for ip in ip_address_ls:
        if ip in new_allowlist:
            continue

        new_allowlist.append(ip)

    return await self.set(
        ip_address_ls=new_allowlist,
        context=context,
        is_suppress_errors=is_suppress_errors,
    )

from_dict classmethod

from_dict(
    auth: DomoAuth, obj: dict[str, Any]
) -> DomoAllowlist

Create a DomoAllowlist instance from a dictionary representation.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
obj	dict[str, Any]	Dictionary containing allowlist data	required

Returns:

Type	Description
DomoAllowlist	DomoAllowlist instance

Source code in src/crew_dcs/classes/DomoInstanceConfig/allowlist.py

@classmethod
def from_dict(cls, auth: DomoAuth, obj: dict[str, Any]) -> "DomoAllowlist":
    """Create a DomoAllowlist instance from a dictionary representation.

    Args:
        auth: Authentication object for API requests
        obj: Dictionary containing allowlist data

    Returns:
        DomoAllowlist instance
    """
    return cls(
        auth=auth,
        allowlist=obj.get("allowlist") or obj.get("addresses", []),
        is_filter_all_traffic_enabled=obj.get("is_filter_all_traffic_enabled"),
        raw=obj,
    )

get async

get(
    return_raw: bool = False,
    debug_api: bool = False,
    debug_num_stacks_to_drop=2,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> list[str]

retrieves the allowlist for an instance

Source code in src/crew_dcs/classes/DomoInstanceConfig/allowlist.py

async def get(
    self,
    return_raw: bool = False,
    debug_api: bool = False,
    debug_num_stacks_to_drop=2,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> list[str]:
    """
    retrieves the allowlist for an instance
    """
    base_context = RouteContext.build_context(
        session=session,
        debug_api=debug_api,
        debug_num_stacks_to_drop=debug_num_stacks_to_drop,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )
    context = RouteContext.build_context(context=context or base_context)

    res = await allowlist_routes.get_allowlist(
        auth=self.auth,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.allowlist = [str(s) for s in res.response]

    return self.allowlist

get_is_filter_all_traffic_enabled async

get_is_filter_all_traffic_enabled(
    debug_api: bool = False,
    return_raw: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> bool

retrieves whether the "filter all traffic" setting is enabled

Source code in src/crew_dcs/classes/DomoInstanceConfig/allowlist.py

async def get_is_filter_all_traffic_enabled(
    self,
    debug_api: bool = False,
    return_raw: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> bool:
    """
    retrieves whether the "filter all traffic" setting is enabled
    """
    base_context = RouteContext.build_context(
        session=session,
        debug_api=debug_api,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )
    context = RouteContext.build_context(context=context or base_context)

    res = await allowlist_routes.get_allowlist_is_filter_all_traffic_enabled(
        auth=self.auth,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.is_filter_all_traffic_enabled = bool(res.response["is_enabled"])

    return self.is_filter_all_traffic_enabled

remove_ips async

remove_ips(
    ip_address_ls: str,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    is_suppress_errors: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> list[str]

removes an IP or CIDR to the allowlist

Source code in src/crew_dcs/classes/DomoInstanceConfig/allowlist.py

async def remove_ips(
    self,
    ip_address_ls: str,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    is_suppress_errors: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> list[str]:
    """
    removes an IP or CIDR to the allowlist
    """
    base_context = RouteContext.build_context(
        session=session,
        debug_api=debug_api,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )
    context = RouteContext.build_context(context=context or base_context)

    allowlist = await self.get(context=context)

    for ip in ip_address_ls:
        if ip not in allowlist:
            continue

        allowlist.remove(ip)

    return await self.set(
        ip_address_ls=allowlist,
        context=context,
        is_suppress_errors=is_suppress_errors,
    )

toggle_is_filter_all_traffic_enabled async

toggle_is_filter_all_traffic_enabled(
    is_enabled: bool,
    debug_api: bool = False,
    return_raw: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> bool

retrieves whether the "filter all traffic" setting is enabled

Source code in src/crew_dcs/classes/DomoInstanceConfig/allowlist.py

async def toggle_is_filter_all_traffic_enabled(
    self,
    is_enabled: bool,
    debug_api: bool = False,
    return_raw: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> bool:
    """
    retrieves whether the "filter all traffic" setting is enabled
    """
    base_context = RouteContext.build_context(
        session=session,
        debug_api=debug_api,
        parent_class=self.__class__.__name__,
        **context_kwargs,
    )
    context = RouteContext.build_context(context=context or base_context)

    await self.get_is_filter_all_traffic_enabled(context=context)

    if self.is_filter_all_traffic_enabled == is_enabled:
        await logger.debug("no action required")

        return bool(self.is_filter_all_traffic_enabled)

    res = await allowlist_routes.toggle_allowlist_is_filter_all_traffic_enabled(
        auth=self.auth,
        is_enabled=is_enabled,
        return_raw=return_raw,
        context=context,
    )

    if return_raw:
        return res

    self.is_filter_all_traffic_enabled = res.response["is_enabled"]

    return bool(self.is_filter_all_traffic_enabled)

    return bool(self.is_filter_all_traffic_enabled)