SecurityAgent / Client / create_target_domain

create_target_domain¶

SecurityAgent.Client.create_target_domain(**kwargs)¶

Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested.

Request Syntax

response = client.create_target_domain(
    targetDomainName='string',
    verificationMethod='DNS_TXT'|'HTTP_ROUTE'|'PRIVATE_VPC',
    tags={
        'string': 'string'
    }
)

Parameters:

targetDomainName (string) –
[REQUIRED]

The domain name to register as a target domain.
verificationMethod (string) –
[REQUIRED]

The method to use for verifying domain ownership. Valid values are DNS_TXT, HTTP_ROUTE, and PRIVATE_VPC.
tags (dict) –
The tags to associate with the target domain.
- (string) –
  
  Key for a resource tag.
  - (string) –
    
    Value for a resource tag.

Return type:

dict

Returns:

Response Syntax

{
    '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)
}

Response Structure

(dict) –

Output for the CreateTargetDomain operation.
- targetDomainId (string) –
  
  The unique identifier of the created 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, including the verification token and instructions.
  - 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.