SecurityAgent / Client / batch_get_target_domains

batch_get_target_domains¶

SecurityAgent.Client.batch_get_target_domains(**kwargs)¶

Retrieves information about one or more target domains.

Request Syntax

response = client.batch_get_target_domains(
    targetDomainIds=[
        'string',
    ]
)

Parameters:

targetDomainIds (list) –

[REQUIRED]

The list of target domain identifiers to retrieve.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'targetDomains': [
        {
            'targetDomainId': 'string',
            'domainName': 'string',
            'verificationStatus': 'PENDING'|'VERIFIED'|'FAILED'|'UNREACHABLE',
            'verificationStatusReason': 'string',
            'verificationDetails': {
                'method': 'DNS_TXT'|'HTTP_ROUTE'|'PRIVATE_VPC',
                'dnsTxt': {
                    'token': 'string',
                    'dnsRecordName': 'string',
                    'dnsRecordType': 'TXT'
                },
                'httpRoute': {
                    'token': 'string',
                    'routePath': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'verifiedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

(dict) –

Output for the BatchGetTargetDomains operation.
- targetDomains (list) –
  
  The list of target domains that were found.
  - (dict) –
    
    Represents a target domain registered for penetration testing. A target domain must be verified through DNS TXT or HTTP route verification before it can be used in pentests.
    - targetDomainId (string) –
      
      The unique identifier of the target domain.
    - domainName (string) –
      
      The domain name of the target domain.
    - verificationStatus (string) –
      
      The current verification status of the target domain.
    - verificationStatusReason (string) –
      
      The reason for the current target domain verification status.
    - verificationDetails (dict) –
      
      The verification details for the target domain.
      - method (string) –
        
        The verification method used for the target domain.
      - dnsTxt (dict) –
        
        The DNS TXT verification details.
        
        token (string) –
        
        The verification token to include in the DNS record value.
        
        dnsRecordName (string) –
        
        The name of the DNS record to create for verification.
        
        dnsRecordType (string) –
        
        The type of DNS record to create. Currently, only TXT is supported.
      - httpRoute (dict) –
        
        The HTTP route verification details.
        
        token (string) –
        
        The verification token to serve at the specified route path.
        
        routePath (string) –
        
        The HTTP route path where the verification token must be served.
    - createdAt (datetime) –
      
      The date and time the target domain was created, in UTC format.
    - verifiedAt (datetime) –
      
      The date and time the target domain was verified, in UTC format.
- notFound (list) –
  
  The list of target domain identifiers that were not found.
  - (string) –