Queries detailed information of attack surfaces of a specified organization.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeOrgAttackSurfaceDetails

The operation that you want to perform. Set the value to DescribeOrgAttackSurfaceDetails.

OrgId Integer Yes 1

The ID of the organization.

RecordId Integer Yes 1

The ID of the record.

Source String Yes Subdomains

The data source of the attack surface. Valid values:

  • Domains: root domains
  • Subdomains: subdomains
  • Ports: ports
  • Hosts: hosts
  • DNSMap: DNS records
  • WebPaths: web file paths
  • WebTechs: web applications

Response parameters

Parameter Type Example Description
FirstScannedAt Long 1585738707000

The time when the attack surface was first detected.

LastScannedAt Long 1585738707000

The time when the attack surface was last detected.

Occurrences Integer 1

The number of times the attack surface was detected.

RequestId String 338E7324-DDEF-4BCF-B560-1ED572FD64A1

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeOrgAttackSurfaceDetails
&OrgId=1
&RecordId=1
&Source=Subdomains
&<Common request parameters>

Sample success responses

XML format

<DescribeOrgAttackSurfaceDetailsResponse>
   <code>200</code>
   <data>
        <LastScannedAt>1585738707000</LastScannedAt>
        <FirstScannedAt>1585738707000</FirstScannedAt>
        <Occurrences>1</Occurrences>
   </data>
   <requestId>338E7324-DDEF-4BCF-B560-1ED572FD64A1</requestId>
   <success>true</success>
</DescribeOrgAttackSurfaceDetailsResponse>

JSON format

{
    "code": 200,
    "data": {
        "LastScannedAt": 1585738707000,
        "FirstScannedAt": 1585738707000,
        "Occurrences": 1
    },
    "requestId": "338E7324-DDEF-4BCF-B560-1ED572FD64A1",
    "success": true
}

Error codes

For a list of error codes, visit the API Error Center.