api.md

Waap

Types:

from gcore.types.waap import WaapGetAccountOverviewResponse

Methods:

• client.waap.get_account_overview() -> WaapGetAccountOverviewResponse

Statistics

Types:

from gcore.types.waap import WaapStatisticItem, WaapStatisticsSeries

Methods:

• client.waap.statistics.get_usage_series(**params) -> WaapStatisticsSeries

Analytics

Types:

from gcore.types.waap import (
    WaapCompactTrafficMetrics,
    WaapSimpleEventStatistics,
    AnalyticsGetTrafficResponse,
    AnalyticsGetTrafficFilteredResponse,
)

Methods:

• client.waap.analytics.get_event_statistics(dimension, **params) -> WaapSimpleEventStatistics
• client.waap.analytics.get_requests(**params) -> SyncOffsetPage[WaapRequestSummary]
• client.waap.analytics.get_traffic(**params) -> AnalyticsGetTrafficResponse
• client.waap.analytics.get_traffic_filtered(**params) -> AnalyticsGetTrafficFilteredResponse

Domains

Types:

from gcore.types.waap import (
    WaapDetailedDomain,
    WaapDomainAPISettings,
    WaapDomainDDOSSettings,
    WaapDomainSettingsModel,
    WaapRequestSummary,
    WaapRuleSet,
    WaapSummaryDomain,
    WaapTrafficMetrics,
    DomainListRuleSetsResponse,
)

Methods:

• client.waap.domains.update(domain_id, **params) -> None
• client.waap.domains.list(**params) -> SyncOffsetPage[WaapSummaryDomain]
• client.waap.domains.delete(domain_id) -> None
• client.waap.domains.get(domain_id) -> WaapDetailedDomain
• client.waap.domains.list_rule_sets(domain_id) -> DomainListRuleSetsResponse

Policies

Types:

from gcore.types.waap.domains import WaapPolicyMode

Methods:

• client.waap.domains.policies.toggle(policy_id, *, domain_id) -> WaapPolicyMode

Settings

Methods:

• client.waap.domains.settings.update(domain_id, **params) -> None
• client.waap.domains.settings.get(domain_id) -> WaapDomainSettingsModel

APIPaths

Types:

from gcore.types.waap.domains import WaapAPIPath

Methods:

• client.waap.domains.api_paths.create(domain_id, **params) -> WaapAPIPath
• client.waap.domains.api_paths.update(path_id, *, domain_id, **params) -> None
• client.waap.domains.api_paths.list(domain_id, **params) -> SyncOffsetPage[WaapAPIPath]
• client.waap.domains.api_paths.delete(path_id, *, domain_id) -> None
• client.waap.domains.api_paths.get(path_id, *, domain_id) -> WaapAPIPath

APIPathGroups

Types:

from gcore.types.waap.domains import APIPathGroupList

Methods:

• client.waap.domains.api_path_groups.list(domain_id) -> APIPathGroupList

APIDiscovery

ScanResults

Types:

from gcore.types.waap.domains.api_discovery import WaapAPIScanResult

Methods:

• client.waap.domains.api_discovery.scan_results.list(domain_id, **params) -> SyncOffsetPage[WaapAPIScanResult]
• client.waap.domains.api_discovery.scan_results.get(scan_id, *, domain_id) -> WaapAPIScanResult

OpenAPI

Types:

from gcore.types.waap.domains.api_discovery import WaapTaskID

Methods:

• client.waap.domains.api_discovery.openapi.scan(domain_id) -> WaapTaskID
• client.waap.domains.api_discovery.openapi.upload(domain_id, **params) -> WaapTaskID

Settings

Types:

from gcore.types.waap.domains.api_discovery import WaapAPIDiscoverySettings

Methods:

• client.waap.domains.api_discovery.settings.update(domain_id, **params) -> WaapAPIDiscoverySettings
• client.waap.domains.api_discovery.settings.get(domain_id) -> WaapAPIDiscoverySettings

Insights

Types:

from gcore.types.waap.domains import WaapInsight

Methods:

• client.waap.domains.insights.list(domain_id, **params) -> SyncOffsetPage[WaapInsight]
• client.waap.domains.insights.get(insight_id, *, domain_id) -> WaapInsight
• client.waap.domains.insights.replace(insight_id, *, domain_id, **params) -> WaapInsight

InsightSilences

Types:

from gcore.types.waap.domains import WaapInsightSilence

Methods:

• client.waap.domains.insight_silences.create(domain_id, **params) -> WaapInsightSilence
• client.waap.domains.insight_silences.update(silence_id, *, domain_id, **params) -> WaapInsightSilence
• client.waap.domains.insight_silences.list(domain_id, **params) -> SyncOffsetPage[WaapInsightSilence]
• client.waap.domains.insight_silences.delete(silence_id, *, domain_id) -> None
• client.waap.domains.insight_silences.get(silence_id, *, domain_id) -> WaapInsightSilence

Statistics

Types:

from gcore.types.waap.domains import (
    WaapBlockedStatistics,
    WaapCountStatistics,
    WaapDDOSAttack,
    WaapDDOSInfo,
    WaapEventStatistics,
    WaapRequestDetails,
)

Methods:

• client.waap.domains.statistics.get_ddos_attacks(domain_id, **params) -> SyncOffsetPage[WaapDDOSAttack]
• client.waap.domains.statistics.get_ddos_info(domain_id, **params) -> SyncOffsetPage[WaapDDOSInfo]
• client.waap.domains.statistics.get_events_aggregated(domain_id, **params) -> WaapEventStatistics
• client.waap.domains.statistics.get_request_details(request_id, *, domain_id) -> WaapRequestDetails

CustomRules

Types:

from gcore.types.waap.domains import WaapCustomRule

Methods:

• client.waap.domains.custom_rules.create(domain_id, **params) -> WaapCustomRule
• client.waap.domains.custom_rules.update(rule_id, *, domain_id, **params) -> None
• client.waap.domains.custom_rules.list(domain_id, **params) -> SyncOffsetPage[WaapCustomRule]
• client.waap.domains.custom_rules.delete(rule_id, *, domain_id) -> None
• client.waap.domains.custom_rules.delete_multiple(domain_id, **params) -> None
• client.waap.domains.custom_rules.get(rule_id, *, domain_id) -> WaapCustomRule
• client.waap.domains.custom_rules.toggle(action, *, domain_id, rule_id) -> None

FirewallRules

Types:

from gcore.types.waap.domains import WaapFirewallRule

Methods:

• client.waap.domains.firewall_rules.create(domain_id, **params) -> WaapFirewallRule
• client.waap.domains.firewall_rules.update(rule_id, *, domain_id, **params) -> None
• client.waap.domains.firewall_rules.list(domain_id, **params) -> SyncOffsetPage[WaapFirewallRule]
• client.waap.domains.firewall_rules.delete(rule_id, *, domain_id) -> None
• client.waap.domains.firewall_rules.delete_multiple(domain_id, **params) -> None
• client.waap.domains.firewall_rules.get(rule_id, *, domain_id) -> WaapFirewallRule
• client.waap.domains.firewall_rules.toggle(action, *, domain_id, rule_id) -> None

AdvancedRules

Types:

from gcore.types.waap.domains import WaapAdvancedRule

Methods:

• client.waap.domains.advanced_rules.create(domain_id, **params) -> WaapAdvancedRule
• client.waap.domains.advanced_rules.update(rule_id, *, domain_id, **params) -> None
• client.waap.domains.advanced_rules.list(domain_id, **params) -> SyncOffsetPage[WaapAdvancedRule]
• client.waap.domains.advanced_rules.delete(rule_id, *, domain_id) -> None
• client.waap.domains.advanced_rules.get(rule_id, *, domain_id) -> WaapAdvancedRule
• client.waap.domains.advanced_rules.toggle(action, *, domain_id, rule_id) -> None

CustomPageSets

Types:

from gcore.types.waap import WaapCustomPagePreview, WaapCustomPageSet

Methods:

• client.waap.custom_page_sets.create(**params) -> WaapCustomPageSet
• client.waap.custom_page_sets.update(set_id, **params) -> None
• client.waap.custom_page_sets.list(**params) -> SyncOffsetPage[WaapCustomPageSet]
• client.waap.custom_page_sets.delete(set_id) -> None
• client.waap.custom_page_sets.get(set_id) -> WaapCustomPageSet
• client.waap.custom_page_sets.preview(**params) -> WaapCustomPagePreview

AdvancedRules

Types:

from gcore.types.waap import WaapAdvancedRuleDescriptor, WaapAdvancedRuleDescriptorList

Methods:

• client.waap.advanced_rules.list() -> WaapAdvancedRuleDescriptorList

Tags

Types:

from gcore.types.waap import WaapTag

Methods:

• client.waap.tags.list(**params) -> SyncOffsetPage[WaapTag]

Organizations

Types:

from gcore.types.waap import WaapOrganization

Methods:

• client.waap.organizations.list(**params) -> SyncOffsetPage[WaapOrganization]

Insights

Types:

from gcore.types.waap import WaapInsightType

Methods:

• client.waap.insights.list_types(**params) -> SyncOffsetPage[WaapInsightType]

IPInfo

Types:

from gcore.types.waap import (
    WaapIPCountryAttack,
    WaapIPDDOSInfoModel,
    WaapIPInfo,
    WaapRuleBlockedRequests,
    WaapTimeSeriesAttack,
    WaapTopSession,
    WaapTopURL,
    WaapTopUserAgent,
    IPInfoGetAttackTimeSeriesResponse,
    IPInfoGetBlockedRequestsResponse,
    IPInfoGetTopURLsResponse,
    IPInfoGetTopUserAgentsResponse,
    IPInfoGetTopUserSessionsResponse,
    IPInfoListAttackedCountriesResponse,
)

Methods:

• client.waap.ip_info.get_attack_time_series(**params) -> IPInfoGetAttackTimeSeriesResponse
• client.waap.ip_info.get_blocked_requests(**params) -> IPInfoGetBlockedRequestsResponse
• client.waap.ip_info.get_ddos_attack_series(**params) -> WaapIPDDOSInfoModel
• client.waap.ip_info.get_ip_info(**params) -> WaapIPInfo
• client.waap.ip_info.get_top_urls(**params) -> IPInfoGetTopURLsResponse
• client.waap.ip_info.get_top_user_agents(**params) -> IPInfoGetTopUserAgentsResponse
• client.waap.ip_info.get_top_user_sessions(**params) -> IPInfoGetTopUserSessionsResponse
• client.waap.ip_info.list_attacked_countries(**params) -> IPInfoListAttackedCountriesResponse

Metrics

Types:

from gcore.types.waap.ip_info import WaapIPInfoCounts

Methods:

• client.waap.ip_info.metrics.list(**params) -> WaapIPInfoCounts