probeDomains

list_domains

List all domains or those matching the given TLD or FQDN filters and return the list as-is

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosgandi.domains.probes
Namelist_domains
Returnlist

Usage

JSON

{
  "name": "list-domains",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosgandi.domains.probes",
    "func": "list_domains"
  }
}

YAML

name: list-domains
provider:
  func: list_domains
  module: chaosgandi.domains.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
fqdn_filterstringnullNoFQDN Filter
tld_filterstringnullNoTLD Filter

See https://api.gandi.net/docs/domains/#v5-domain-domains

Signature

def list_domains(
    fqdn_filter: str = None,
    tld_filter: str = None,
    configuration: Dict[str, Dict[str, str]] = None,
    secrets: Dict[str, Dict[str, str]] = None) -> List[Dict[str, Any]]:
  pass