`client.ips`¶

Look up IP relationships and statistics.

Property¶

client.ips

Methods¶

alerts(ip: str) -> AlertsResults: fetch alerts related to an IP address.
stats(ip: str) -> InOrgIPStatsResults: fetch in-organization statistics for an IP address.

Notes¶

This endpoint is relationship-oriented. It does not expose a general IP collection listing method.

API¶

IPResults ¶

IPResults(
    endpoint: BaseEndpoint,
    params: dict[str, str],
    *,
    path: str | None = None,
    single: bool = False,
    files: bool = False,
    method: str = "GET",
    request_kwargs: dict[str, Any] | None = None,
    use_concurrent_skip_pagination: bool | None = None,
    skip_page_size: int | None = None,
    skip_max_concurrent: int | None = None,
)

Results from the /api/ips endpoint.

InOrgIPStatsResults ¶

InOrgIPStatsResults(
    endpoint: BaseEndpoint,
    params: dict[str, str],
    *,
    path: str | None = None,
    single: bool = False,
    files: bool = False,
    method: str = "GET",
    request_kwargs: dict[str, Any] | None = None,
    use_concurrent_skip_pagination: bool | None = None,
    skip_page_size: int | None = None,
    skip_max_concurrent: int | None = None,
)

Results from the /api/ips/{ip}/stats endpoint.

IPEndpoint ¶

IPEndpoint(http: Client, auth: MSALAuth)

Endpoint for /api/ips

alerts ¶

alerts(ip: str) -> AlertsResults

Get alerts related to a specific IP address.

Docs: - https://learn.microsoft.com/en-us/defender-endpoint/api/get-ip-related-alerts

stats ¶

stats(ip: str) -> InOrgIPStatsResults

Get stats for a specific IP address.

Docs: - https://learn.microsoft.com/en-us/defender-endpoint/api/get-ip-stats

client.ips¶