Share via


Reports - Get Snapshot

Get the most recent snapshot of asset summary values for the snapshot request.

POST {endpoint}/reports/assets:getSnapshot?api-version=2024-10-01-preview

URI Parameters

Name In Required Type Description
endpoint
path True

string

The endpoint hosting the requested resource. For example, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
labelName

string

The name of the label to retrieve a snapshot for.

metric

string

The metric to retrieve a snapshot for.

page

integer (int32)

The page to retrieve.

size

integer (int32)

The number of assets per page.

Responses

Name Type Description
200 OK

ReportAssetSnapshotResult

The request has succeeded.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://easm.defender.microsoft.com/.default

Examples

Reports_GetSnapshot

Sample request

POST {endpoint}/reports/assets:getSnapshot?api-version=2024-10-01-preview

{
  "metric": "site_status_active",
  "page": 0,
  "size": 5
}

Sample response

{
  "displayName": "Metric Name",
  "metric": "metricName",
  "labelName": null,
  "updatedAt": "2022-12-12T05:36:02.000+00:00",
  "description": "Metric description.",
  "assets": {
    "totalElements": 200,
    "nextLink": "https://<api-endpoint>/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/workspaces/ThisisaWorkspace/reports/assets:getSnapshot?skip=1&maxpagesize=25&api-version=2023-03-01-preview",
    "value": [
      {
        "id": "host$$contoso.com",
        "name": "contoso.com",
        "displayName": "contoso.com",
        "kind": "host",
        "uuid": "00000000-0000-0000-0000-000000000000",
        "asset": {
          "host": "contoso.com",
          "domain": "contoso.com",
          "ipAddresses": [],
          "webComponents": [
            {
              "name": "Component Name",
              "type": "Component Type",
              "version": "1.0.0",
              "ruleId": [],
              "cve": [],
              "ports": [],
              "sources": []
            }
          ],
          "headers": [],
          "attributes": [],
          "cookies": [],
          "sslCerts": [],
          "parentHosts": [],
          "childHosts": [],
          "services": [],
          "cnames": [],
          "sources": [],
          "firstSeen": "2017-09-23T12:55:11.000+00:00",
          "lastSeen": "2022-12-10T04:31:45.000+00:00",
          "resourceUrls": [],
          "scanMetadata": [],
          "asns": [],
          "ipBlocks": [],
          "responseBodies": [],
          "domainAsset": {
            "domain": "contoso.com",
            "registrarIanaIds": [],
            "registrantContacts": [],
            "registrantOrgs": [
              {
                "value": "Contoso",
                "sources": [],
                "recent": true
              }
            ],
            "adminContacts": [],
            "technicalContacts": [],
            "alexaInfos": [],
            "nameServers": [],
            "mailServers": [],
            "whoisServers": [],
            "domainStatuses": [],
            "registrarCreatedAt": [],
            "registrarUpdatedAt": [],
            "registrarExpiresAt": [],
            "soaRecords": [],
            "registrarNames": [
              {
                "value": "Contoso",
                "sources": [],
                "recent": true
              }
            ],
            "sources": [],
            "firstSeen": "2017-09-23T12:55:11.000+00:00",
            "lastSeen": "2022-12-10T04:31:45.000+00:00",
            "parkedDomain": [],
            "registrantNames": [],
            "adminNames": [],
            "technicalNames": [],
            "adminOrgs": [],
            "technicalOrgs": [],
            "registrantPhones": [],
            "adminPhones": [],
            "technicalPhones": []
          },
          "nsRecord": [],
          "mxRecord": [],
          "webserver": [],
          "location": [],
          "nxdomain": [],
          "sslServerConfig": [],
          "isWildcard": [],
          "banners": [],
          "ipv4": [],
          "ipv6": []
        },
        "createdDate": "2017-09-23T12:55:11.000+00:00",
        "updatedDate": "2022-12-10T04:31:45.000+00:00",
        "state": null,
        "externalId": null,
        "labels": null,
        "wildcard": false,
        "discoGroupName": null,
        "auditTrail": [
          {
            "id": null,
            "name": "contoso.com",
            "displayName": null,
            "kind": "domain",
            "reason": null
          },
          {
            "id": null,
            "name": "contoso.com",
            "displayName": null,
            "kind": "host",
            "reason": null
          }
        ],
        "reason": null
      },
      {
        "id": "host$$www.contoso.net",
        "name": "www.contoso.net",
        "displayName": "www.contoso.net",
        "kind": "host",
        "uuid": "00000000-0000-0000-0000-000000000000",
        "asset": {
          "host": "www.contoso.net",
          "domain": "contoso.net",
          "ipAddresses": [],
          "webComponents": [
            {
              "name": "componentName",
              "type": "componentType",
              "ruleId": [],
              "cve": [],
              "ports": [],
              "sources": []
            }
          ],
          "headers": [],
          "attributes": [],
          "cookies": [],
          "sslCerts": [],
          "parentHosts": [],
          "childHosts": [],
          "services": [],
          "cnames": [],
          "sources": [],
          "firstSeen": "2017-09-26T00:59:26.862+00:00",
          "lastSeen": "2022-11-27T16:54:06.000+00:00",
          "resourceUrls": [],
          "scanMetadata": [],
          "asns": [],
          "ipBlocks": [],
          "responseBodies": [],
          "domainAsset": {
            "domain": "contoso.net",
            "registrarIanaIds": [],
            "registrantContacts": [],
            "registrantOrgs": [
              {
                "value": "Contoso",
                "sources": [],
                "recent": true
              }
            ],
            "adminContacts": [],
            "technicalContacts": [],
            "alexaInfos": [],
            "nameServers": [],
            "mailServers": [],
            "whoisServers": [],
            "domainStatuses": [],
            "registrarCreatedAt": [],
            "registrarUpdatedAt": [],
            "registrarExpiresAt": [],
            "soaRecords": [],
            "registrarNames": [
              {
                "value": "Contoso",
                "sources": [],
                "recent": true
              }
            ],
            "sources": [],
            "firstSeen": "2017-09-26T00:59:26.862+00:00",
            "lastSeen": "2022-11-27T16:54:06.000+00:00",
            "parkedDomain": [],
            "registrantNames": [],
            "adminNames": [],
            "technicalNames": [],
            "adminOrgs": [],
            "technicalOrgs": [],
            "registrantPhones": [],
            "adminPhones": [],
            "technicalPhones": []
          },
          "nsRecord": [],
          "mxRecord": [],
          "webserver": [],
          "location": [],
          "nxdomain": [],
          "sslServerConfig": [],
          "isWildcard": [],
          "banners": [],
          "ipv4": [],
          "ipv6": []
        },
        "createdDate": "2017-09-26T00:59:26.862+00:00",
        "updatedDate": "2022-11-27T16:54:06.000+00:00",
        "state": null,
        "externalId": null,
        "labels": null,
        "wildcard": false,
        "discoGroupName": null,
        "auditTrail": [
          {
            "id": null,
            "name": "contoso.net",
            "displayName": null,
            "kind": "domain",
            "reason": null
          },
          {
            "id": null,
            "name": "www.contoso.net",
            "displayName": null,
            "kind": "host",
            "reason": null
          }
        ],
        "reason": null
      },
      {
        "id": "domain$$contoso.com",
        "name": "contoso.com",
        "displayName": "contoso.com",
        "kind": "domain",
        "uuid": "00000000-0000-0000-0000-000000000000",
        "asset": {
          "domain": "contoso.com",
          "whoisId": 1234567890123456789,
          "registrarIanaIds": [
            {
              "value": 123,
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 1
                }
              ],
              "recent": true
            },
            {
              "value": 321,
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-07-05T04:50:47.462+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 1
                }
              ]
            }
          ],
          "registrantContacts": [
            {
              "value": "admin@contoso.com",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            },
            {
              "value": "domains@contoso.net",
              "firstSeen": "2022-07-05T04:50:47.462+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-07-05T04:50:47.462+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 3
                }
              ],
              "recent": true
            }
          ],
          "registrantOrgs": [
            {
              "value": "Contoso",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            },
            {
              "value": "Contoso",
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-10-11T11:37:41.168+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-10-11T11:37:41.168+00:00",
                  "count": 2
                }
              ]
            },
            {
              "value": "Contoso",
              "firstSeen": "2022-07-05T04:50:47.462+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-07-05T04:50:47.462+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 3
                }
              ]
            },
            {
              "value": "Contoso",
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-07-05T04:50:47.460+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-06-02T12:09:19.577+00:00",
                  "lastSeen": "2022-07-05T04:50:47.460+00:00",
                  "count": 2
                }
              ]
            }
          ],
          "adminContacts": [
            {
              "value": "admin@contoso.com",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            },
            {
              "value": "domains@contoso.net",
              "firstSeen": "2022-07-05T04:50:47.462+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-07-05T04:50:47.462+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 3
                }
              ],
              "recent": true
            }
          ],
          "technicalContacts": [
            {
              "value": "admin@contoso.com",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            },
            {
              "value": "domains@contoso.net",
              "firstSeen": "2022-07-05T04:50:47.462+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-07-05T04:50:47.462+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 3
                }
              ],
              "recent": true
            }
          ],
          "alexaInfos": [],
          "nameServers": [
            {
              "value": "ns1.contoso.com",
              "firstSeen": "2022-06-02T12:09:19.000+00:00",
              "lastSeen": "2022-11-29T10:07:55.000+00:00",
              "sources": [
                {
                  "source": "pdns.NS",
                  "firstSeen": "2022-06-02T12:09:19.000+00:00",
                  "lastSeen": "2022-11-29T10:07:55.000+00:00",
                  "count": 85
                },
                {
                  "source": "whois",
                  "firstSeen": "2022-06-02T12:09:19.577+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 10
                }
              ],
              "recent": true
            }
          ],
          "mailServers": [],
          "whoisServers": [
            {
              "value": "rand.contoso.com",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "domainStatuses": [
            {
              "value": "clientDeleteProhibited",
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 4
                }
              ],
              "recent": true
            },
            {
              "value": "clientTransferProhibited",
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 4
                }
              ],
              "recent": true
            },
            {
              "value": "clientUpdateProhibited",
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 4
                }
              ],
              "recent": true
            },
            {
              "value": "serverTransferProhibited",
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-10-11T11:37:41.168+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-10-11T11:37:41.168+00:00",
                  "count": 2
                }
              ],
              "recent": true
            },
            {
              "value": "transferPeriod",
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-10-11T11:37:41.168+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-10-11T11:37:41.168+00:00",
                  "count": 2
                }
              ],
              "recent": true
            },
            {
              "value": "deleteProhibited",
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-06-02T12:09:19.577+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 5
                }
              ],
              "recent": true
            },
            {
              "value": "renewProhibited",
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-06-02T12:09:19.577+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 5
                }
              ],
              "recent": true
            },
            {
              "value": "transferProhibited",
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-06-02T12:09:19.577+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 5
                }
              ],
              "recent": true
            },
            {
              "value": "updateProhibited",
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-06-02T12:09:19.577+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 5
                }
              ],
              "recent": true
            }
          ],
          "registrarCreatedAt": [
            {
              "value": 1654103468000,
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 1
                }
              ],
              "recent": true
            }
          ],
          "registrarUpdatedAt": [
            {
              "value": 1662644948000,
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 1
                }
              ],
              "recent": true
            },
            {
              "value": 1662590259000,
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-10-11T11:37:41.168+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-10-11T11:37:41.168+00:00",
                  "count": 1
                }
              ]
            },
            {
              "value": 1654103471000,
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-07-05T04:50:47.462+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 1
                }
              ]
            }
          ],
          "registrarExpiresAt": [
            {
              "value": 1717286399000,
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 1
                }
              ],
              "recent": true
            },
            {
              "value": 1685663999000,
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-09-08T13:01:12.837+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-07-05T04:50:47.462+00:00",
                  "lastSeen": "2022-09-08T13:01:12.837+00:00",
                  "count": 1
                }
              ]
            }
          ],
          "soaRecords": [
            {
              "nameServer": "ns1.contoso.org",
              "email": "contoso@contoso.com",
              "firstSeen": "2022-06-02T12:09:19.000+00:00",
              "lastSeen": "2022-11-29T10:07:55.000+00:00",
              "serialNumber": 1,
              "recent": true
            }
          ],
          "detailedFromWhoisAt": "2022-11-12T01:15:37.021+00:00",
          "registrarNames": [
            {
              "value": "Contoso",
              "firstSeen": "2022-09-08T13:01:12.839+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-09-08T13:01:12.839+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 4
                }
              ],
              "recent": true
            }
          ],
          "sources": [
            {
              "source": "pdns",
              "firstSeen": "2022-06-02T12:09:19.000+00:00",
              "lastSeen": "2022-11-29T10:07:55.000+00:00",
              "count": 403
            },
            {
              "source": "whois",
              "firstSeen": "2022-06-02T12:09:19.577+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "count": 10
            },
            {
              "source": "minicrawl",
              "firstSeen": "2022-06-02T17:45:46.168+00:00",
              "lastSeen": "2022-11-09T19:13:49.643+00:00",
              "count": 28
            }
          ],
          "firstSeen": "2022-06-02T12:09:19.000+00:00",
          "lastSeen": "2022-11-29T10:07:55.000+00:00",
          "count": 441,
          "parkedDomain": [
            {
              "value": false,
              "firstSeen": "2022-06-02T17:45:46.168+00:00",
              "lastSeen": "2022-11-09T19:13:49.643+00:00",
              "sources": [],
              "recent": true
            }
          ],
          "registrantNames": [
            {
              "value": "Contoso",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "adminNames": [
            {
              "value": "Contoso",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "technicalNames": [
            {
              "value": "Contoso",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "adminOrgs": [
            {
              "value": "Contoso",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "technicalOrgs": [
            {
              "value": "Contoso",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "registrantPhones": [
            {
              "value": "+1.1234567890",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "adminPhones": [
            {
              "value": "+1.1234567890",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ],
          "technicalPhones": [
            {
              "value": "+1.1234567890",
              "firstSeen": "2022-10-11T11:37:41.170+00:00",
              "lastSeen": "2022-11-12T01:15:37.021+00:00",
              "sources": [
                {
                  "source": "whois",
                  "firstSeen": "2022-10-11T11:37:41.170+00:00",
                  "lastSeen": "2022-11-12T01:15:37.021+00:00",
                  "count": 2
                }
              ],
              "recent": true
            }
          ]
        },
        "createdDate": "2022-10-10T17:33:27.434+00:00",
        "updatedDate": "2022-10-25T08:00:23.447+00:00",
        "state": "confirmed",
        "externalId": null,
        "labels": [],
        "wildcard": false,
        "discoGroupName": "Contoso",
        "auditTrail": null,
        "reason": null
      },
      {
        "id": "page$$https://www.contoso.com/",
        "name": "https://www.contoso.com/",
        "displayName": "https://www.contoso.com/",
        "kind": "page",
        "uuid": "00000000-0000-0000-0000-000000000000",
        "asset": {
          "url": "https://www.contoso.com/",
          "ipAddresses": [],
          "successful": [],
          "httpResponseCodes": [],
          "httpResponseMessages": [],
          "responseTimes": [],
          "frames": [],
          "windows": [],
          "nonHtmlFrames": [],
          "undirectedContent": [],
          "contentTypes": [],
          "contentLengths": [],
          "windowNames": [],
          "charsets": [],
          "titles": [],
          "languages": [],
          "responseHeaders": [],
          "cookies": [],
          "webComponents": [
            {
              "name": "Component Name",
              "type": "Component Type",
              "version": "1.0.0",
              "ruleId": [],
              "cve": [],
              "ports": [],
              "sources": []
            }
          ],
          "attributes": [],
          "assetSecurityPolicies": [],
          "responseBodyMinhashSignatures": [],
          "fullDomMinhashSignatures": [],
          "responseBodyHashSignatures": [],
          "errors": [],
          "sslCerts": [],
          "sources": [],
          "firstSeen": "2019-06-16T12:55:04.360+00:00",
          "lastSeen": "2022-11-09T15:57:53.425+00:00",
          "redirectUrls": [],
          "finalUrls": [],
          "finalResponseCodes": [],
          "parkedPage": [],
          "resourceUrls": [],
          "guids": [],
          "finalIpAddresses": [],
          "asns": [],
          "ipBlocks": [],
          "finalAsns": [],
          "finalIpBlocks": [],
          "responseBodies": [],
          "domainAsset": {
            "domain": "contoso.com",
            "registrarIanaIds": [],
            "registrantContacts": [],
            "registrantOrgs": [
              {
                "value": "Contoso",
                "sources": [],
                "recent": true
              }
            ],
            "adminContacts": [],
            "technicalContacts": [],
            "alexaInfos": [],
            "nameServers": [],
            "mailServers": [],
            "whoisServers": [],
            "domainStatuses": [],
            "registrarCreatedAt": [],
            "registrarUpdatedAt": [],
            "registrarExpiresAt": [],
            "soaRecords": [],
            "registrarNames": [
              {
                "value": "Contoso",
                "sources": [],
                "recent": true
              }
            ],
            "sources": [],
            "firstSeen": "2019-06-16T12:55:04.360+00:00",
            "lastSeen": "2022-11-09T15:57:53.425+00:00",
            "parkedDomain": [],
            "registrantNames": [],
            "adminNames": [],
            "technicalNames": [],
            "adminOrgs": [],
            "technicalOrgs": [],
            "registrantPhones": [],
            "adminPhones": [],
            "technicalPhones": []
          },
          "location": [],
          "services": [],
          "cnames": [],
          "cdns": [],
          "domain": "contoso.com",
          "sslServerConfig": [],
          "gdprAssetSecurityPolicies": [],
          "ipv4": [],
          "ipv6": []
        },
        "createdDate": "2019-06-16T12:55:04.360+00:00",
        "updatedDate": "2022-11-09T15:57:53.425+00:00",
        "state": null,
        "externalId": null,
        "labels": null,
        "wildcard": false,
        "discoGroupName": null,
        "auditTrail": [
          {
            "id": null,
            "name": "contoso.net",
            "displayName": null,
            "kind": "domain",
            "reason": null
          },
          {
            "id": null,
            "name": "WhoisOrganization:Contoso",
            "displayName": null,
            "kind": "attribute",
            "reason": null
          },
          {
            "id": null,
            "name": "contoso.com",
            "displayName": null,
            "kind": "domain",
            "reason": null
          },
          {
            "id": null,
            "name": "www.contoso.com",
            "displayName": null,
            "kind": "host",
            "reason": null
          }
        ],
        "reason": null
      },
      {
        "id": "ipAddress$$10.000.000.00",
        "name": "10.000.000.00",
        "displayName": "10.000.000.00",
        "kind": "ipAddress",
        "uuid": "00000000-0000-0000-0000-000000000000",
        "asset": {
          "ipAddress": "10.000.000.00",
          "asns": [
            {
              "value": 64501,
              "sources": [],
              "recent": true
            }
          ],
          "reputations": [],
          "webComponents": [
            {
              "name": "Component Name",
              "type": "Component Type",
              "ruleId": [],
              "cve": [],
              "ports": [],
              "sources": []
            }
          ],
          "netRanges": [],
          "headers": [],
          "attributes": [],
          "cookies": [],
          "sslCerts": [],
          "services": [],
          "ipBlocks": [
            {
              "ipBlock": "10.000.000.00/18",
              "sources": [],
              "recent": true
            }
          ],
          "sources": [],
          "firstSeen": "2010-06-24T11:57:03.000+00:00",
          "lastSeen": "2022-12-10T22:10:54.000+00:00",
          "banners": [],
          "scanMetadata": [],
          "nsRecord": [],
          "mxRecord": [],
          "location": [],
          "hosts": [],
          "nxdomain": [],
          "sslServerConfig": []
        },
        "createdDate": "2010-06-24T11:57:03.000+00:00",
        "updatedDate": "2022-12-10T22:10:54.000+00:00",
        "state": null,
        "externalId": null,
        "labels": null,
        "wildcard": false,
        "discoGroupName": null,
        "auditTrail": [
          {
            "id": null,
            "name": "contoso.net",
            "displayName": null,
            "kind": "domain",
            "reason": null
          },
          {
            "id": null,
            "name": "WhoisOrganization:Contoso",
            "displayName": null,
            "kind": "attribute",
            "reason": null
          },
          {
            "id": null,
            "name": "contoso.com",
            "displayName": null,
            "kind": "domain",
            "reason": null
          },
          {
            "id": null,
            "name": "contoso.com",
            "displayName": null,
            "kind": "host",
            "reason": null
          }
        ],
        "reason": null
      }
    ],
    "mark": null
  }
}

Definitions

Name Description
AlexaInfo
AsAsset
AsAssetResource
AssetPageResult

The page of assets that match the provided metric.

AssetSecurityPolicy
AssetState

The state of assets

Attribute
AuditTrailItem

The history of how this asset was pulled into the workspace through the discovery process.

AuditTrailItemKind

The kind of asset.

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Banner
ContactAsset
ContactAssetResource
Cookie
Cve
Cvss3Summary
DependentResource
DomainAsset
DomainAssetResource
GuidPair
HostAsset
HostAssetResource
HostCore
IpAddressAsset
IpAddressAssetResource
IpBlock
IpBlockAsset
IpBlockAssetResource
Location
ObservedBoolean
ObservedHeader
ObservedInteger
ObservedIntegers
ObservedLocation
ObservedLong
ObservedPortState
ObservedPortStateValue

state of observed port

ObservedString
PageAsset
PageAssetRedirectType

The redirect type of a page

PageAssetResource
PageCause
Port
ReportAssetSnapshotRequest

A request body used to retrieve an asset report snapshot.

ReportAssetSnapshotResult

A snapshot of assets captured daily for the provided metric. Asset details only contain primary properties. Detailed asset data can be retrieved from the asset endpoints.

Reputation
ResourceUrl
ScanMetadata
Service
SoaRecord
Source
SslCertAsset
SslCertAssetResource
SslCertAssetValidationType

The validation type of a Ssl certificate

SslServerConfig
SubResourceIntegrityCheck
WebComponent

AlexaInfo

Name Type Description
alexaRank

integer (int64)

category

string

count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

AsAsset

Name Type Description
adminContacts

ObservedString[]

adminNames

ObservedString[]

adminOrgs

ObservedString[]

adminPhones

ObservedString[]

asNames

ObservedString[]

asn

integer (int64)

count

integer (int64)

countries

ObservedString[]

detailedFromWhoisAt

string (date-time)

firstSeen

string (date-time)

lastSeen

string (date-time)

orgIds

ObservedString[]

orgNames

ObservedString[]

registrantContacts

ObservedString[]

registrantNames

ObservedString[]

registrantPhones

ObservedString[]

registrarCreatedAt

ObservedLong[]

registrarNames

ObservedString[]

registrarUpdatedAt

ObservedLong[]

registries

ObservedString[]

sources

Source[]

technicalContacts

ObservedString[]

technicalNames

ObservedString[]

technicalOrgs

ObservedString[]

technicalPhones

ObservedString[]

AsAssetResource

Name Type Description
asset

AsAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

as

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

AssetPageResult

The page of assets that match the provided metric.

Name Type Description
mark

string

The cursor mark to be used on the next request. Not set if using paging.

nextLink

string

The link to access the next page of results. Not set if at the end of the result set.

totalElements

integer (int64)

The total number of items available in the full result set.

value AssetResource[]:

The items in the current page of results.

AssetSecurityPolicy

Name Type Description
count

integer (int64)

description

string

firstSeen

string (date-time)

isAffected

boolean

lastSeen

string (date-time)

policyName

string

recent

boolean

sources

Source[]

AssetState

The state of assets

Value Description
candidate
confirmed
dismissed
candidateInvestigate
associatedPartner
associatedThirdparty
archived

Attribute

Name Type Description
attributeType

string

attributeValue

string

count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

sources

Source[]

AuditTrailItem

The history of how this asset was pulled into the workspace through the discovery process.

Name Type Description
displayName

string

The name that can be used for display purposes.

id

string

This is typically the same as the name but might be different for different models.

kind

AuditTrailItemKind

The kind of asset.

name

string

The caller provided unique name for the resource.

reason

string

An explanation of why this audit trail node was discovered from the previous node.

AuditTrailItemKind

The kind of asset.

Value Description
as
contact
domain
host
ipAddress
ipBlock
page
sslCert

Azure.Core.Foundations.Error

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.

details

Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.

innererror

Azure.Core.Foundations.InnerError

An object containing more specific information than the current object about the error.

message

string

A human-readable representation of the error.

target

string

The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name Type Description
code

string

One of a server-defined set of error codes.

innererror

Azure.Core.Foundations.InnerError

Inner error.

Name Type Description
banner

string

bannerMetadata

string

count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

port

integer (int32)

recent

boolean

scanType

string

sha256

string

sources

Source[]

ContactAsset

Name Type Description
count

integer (int64)

email

string

firstSeen

string (date-time)

lastSeen

string (date-time)

names

ObservedString[]

organizations

ObservedString[]

sources

Source[]

ContactAssetResource

Name Type Description
asset

ContactAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

contact

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

Name Type Description
cookieDomain

string

cookieExpiryDate

string (date-time)

cookieName

string

count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

Cve

Name Type Description
cvss3Summary

Cvss3Summary

cvssScore

number (float)

cweId

string

name

string

Cvss3Summary

Name Type Description
attackComplexity

string

attackVector

string

availabilityImpact

string

baseScore

number (float)

baseSeverity

string

confidentialityImpact

string

exploitCodeMaturity

string

exploitabilityScore

number (float)

impactScore

number (float)

integrityImpact

string

privilegesRequired

string

remediationLevel

string

reportConfidence

string

scope

string

userInteraction

string

vectorString

string

version

string

DependentResource

Name Type Description
cached

boolean

contentType

string

count

integer (int64)

firstSeen

string (date-time)

firstSeenCrawlGuid

string

firstSeenPageGuid

string

firstSeenResourceGuid

string

host

string

lastObservedActualSriHash

string

lastObservedExpectedSriHash

string

lastObservedValidation

string (date-time)

lastObservedViolation

string (date-time)

lastSeen

string (date-time)

lastSeenCrawlGuid

string

lastSeenPageGuid

string

lastSeenResourceGuid

string

md5

string

responseBodyMinhash

integer[] (int32)

responseBodySize

integer (int64)

sha256

string

sha384

string

sha512

string

sriChecks

SubResourceIntegrityCheck[]

url

string (uri)

DomainAsset

Name Type Description
adminContacts

ObservedString[]

adminNames

ObservedString[]

adminOrgs

ObservedString[]

adminPhones

ObservedString[]

alexaInfos

AlexaInfo[]

count

integer (int64)

detailedFromWhoisAt

string (date-time)

domain

string

domainStatuses

ObservedString[]

firstSeen

string (date-time)

lastSeen

string (date-time)

mailServers

ObservedString[]

nameServers

ObservedString[]

parkedDomain

ObservedBoolean[]

registrantContacts

ObservedString[]

registrantNames

ObservedString[]

registrantOrgs

ObservedString[]

registrantPhones

ObservedString[]

registrarCreatedAt

ObservedLong[]

registrarExpiresAt

ObservedLong[]

registrarIanaIds

ObservedInteger[]

registrarNames

ObservedString[]

registrarUpdatedAt

ObservedLong[]

soaRecords

SoaRecord[]

sources

Source[]

technicalContacts

ObservedString[]

technicalNames

ObservedString[]

technicalOrgs

ObservedString[]

technicalPhones

ObservedString[]

whoisId

integer (int64)

whoisServers

ObservedString[]

DomainAssetResource

Name Type Description
asset

DomainAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

domain

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

GuidPair

Name Type Description
crawlStateGuid

string

loadDate

string (date-time)

pageGuid

string

recent

boolean

HostAsset

Name Type Description
asns

ObservedLong[]

attributes

Attribute[]

banners

Banner[]

childHosts

ObservedString[]

cnames

ObservedString[]

cookies

Cookie[]

count

integer (int64)

domain

string

domainAsset

DomainAsset

firstSeen

string (date-time)

headers

ObservedHeader[]

host

string

hostCore

HostCore

ipAddresses

ObservedString[]

ipBlocks

IpBlock[]

ipv4

ObservedBoolean[]

ipv6

ObservedBoolean[]

isWildcard

ObservedBoolean[]

lastSeen

string (date-time)

location

ObservedLocation[]

mxRecord

ObservedBoolean[]

nsRecord

ObservedBoolean[]

nxdomain

ObservedBoolean[]

parentHosts

ObservedString[]

resourceUrls

ResourceUrl[]

responseBodies

ObservedString[]

scanMetadata

ScanMetadata[]

services

Service[]

sources

Source[]

sslCerts

SslCertAsset[]

sslServerConfig

SslServerConfig[]

webComponents

WebComponent[]

webserver

ObservedBoolean[]

HostAssetResource

Name Type Description
asset

HostAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

host

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

HostCore

Name Type Description
alexaRank

integer (int32)

blacklistCauseCount

integer (int64)

blacklistCauseFirstSeen

string (date-time)

blacklistCauseLastSeen

string (date-time)

blacklistResourceCount

integer (int64)

blacklistResourceFirstSeen

string (date-time)

blacklistResourceLastSeen

string (date-time)

blacklistSequenceCount

integer (int64)

blacklistSequenceFirstSeen

string (date-time)

blacklistSequenceLastSeen

string (date-time)

count

integer (int64)

domain

string

domainMalwareReputationScore

integer (int32)

domainPhishReputationScore

integer (int32)

domainReputationScore

integer (int32)

domainScamReputationScore

integer (int32)

domainSpamReputationScore

integer (int32)

firstSeen

string (date-time)

host

string

hostMalwareReputationScore

integer (int32)

hostPhishReputationScore

integer (int32)

hostReputationScore

integer (int32)

hostScamReputationScore

integer (int32)

hostSpamReputationScore

integer (int32)

lastSeen

string (date-time)

malwareCauseCount

integer (int64)

malwareResourceCount

integer (int64)

malwareSequenceCount

integer (int64)

phishCauseCount

integer (int64)

phishResourceCount

integer (int64)

phishSequenceCount

integer (int64)

scamCauseCount

integer (int64)

scamResourceCount

integer (int64)

scamSequenceCount

integer (int64)

spamCauseCount

integer (int64)

spamResourceCount

integer (int64)

spamSequenceCount

integer (int64)

uuid

string

IpAddressAsset

Name Type Description
asns

ObservedLong[]

attributes

Attribute[]

banners

Banner[]

cookies

Cookie[]

count

integer (int64)

firstSeen

string (date-time)

headers

ObservedHeader[]

hosts

ObservedString[]

ipAddress

string

ipBlocks

IpBlock[]

ipv4

boolean

ipv6

boolean

lastSeen

string (date-time)

location

ObservedLocation[]

mxRecord

ObservedBoolean[]

netRanges

ObservedString[]

nsRecord

ObservedBoolean[]

nxdomain

ObservedBoolean[]

reputations

Reputation[]

scanMetadata

ScanMetadata[]

services

Service[]

sources

Source[]

sslCerts

SslCertAsset[]

sslServerConfig

SslServerConfig[]

webComponents

WebComponent[]

IpAddressAssetResource

Name Type Description
asset

IpAddressAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

ipAddress

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

IpBlock

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

ipBlock

string

lastSeen

string (date-time)

recent

boolean

sources

Source[]

IpBlockAsset

Name Type Description
adminContacts

ObservedString[]

adminNames

ObservedString[]

adminOrgs

ObservedString[]

adminPhones

ObservedString[]

asns

ObservedLong[]

bgpPrefixes

ObservedString[]

count

integer (int64)

detailedFromWhoisAt

string (date-time)

endIp

string

firstSeen

string (date-time)

ipBlock

string

ipv4

boolean

ipv6

boolean

lastSeen

string (date-time)

location

ObservedLocation[]

netNames

ObservedString[]

netRanges

ObservedString[]

registrantContacts

ObservedString[]

registrantNames

ObservedString[]

registrantOrgs

ObservedString[]

registrantPhones

ObservedString[]

registrarCreatedAt

ObservedLong[]

registrarExpiresAt

ObservedLong[]

registrarUpdatedAt

ObservedLong[]

reputations

Reputation[]

sources

Source[]

startIp

string

technicalContacts

ObservedString[]

technicalNames

ObservedString[]

technicalOrgs

ObservedString[]

technicalPhones

ObservedString[]

IpBlockAssetResource

Name Type Description
asset

IpBlockAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

ipBlock

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

Location

Name Type Description
areaCode

integer (int32)

city

string

countryCode

string

countryName

string

dmaCode

integer (int32)

latitude

number (float)

longitude

number (float)

metroCodeId

integer (int32)

postalCode

string

region

string

regionName

string

ObservedBoolean

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

sources

Source[]

value

boolean

ObservedHeader

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

headerName

string

headerValue

string

lastSeen

string (date-time)

recent

boolean

ObservedInteger

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

sources

Source[]

value

integer (int32)

ObservedIntegers

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

sources

Source[]

values

integer[] (int32)

ObservedLocation

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

sources

Source[]

value

Location

ObservedLong

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

sources

Source[]

value

integer (int64)

ObservedPortState

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

port

integer (int32)

recent

boolean

value

ObservedPortStateValue

state of observed port

ObservedPortStateValue

state of observed port

Value Description
open
closed
filtered

ObservedString

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

sources

Source[]

value

string

PageAsset

Name Type Description
asns

ObservedLong[]

assetSecurityPolicies

AssetSecurityPolicy[]

attributes

Attribute[]

cause

PageCause

cdns

ObservedString[]

charsets

ObservedString[]

cnames

ObservedString[]

contentLengths

ObservedLong[]

contentTypes

ObservedString[]

cookies

Cookie[]

count

integer (int64)

domain

string

domainAsset

DomainAsset

errors

ObservedString[]

finalAsns

ObservedLong[]

finalIpAddresses

ObservedString[]

finalIpBlocks

IpBlock[]

finalResponseCodes

ObservedInteger[]

finalUrls

ObservedString[]

firstSeen

string (date-time)

frames

ObservedBoolean[]

fullDomMinhashSignatures

ObservedIntegers[]

gdprAssetSecurityPolicies

AssetSecurityPolicy[]

guids

GuidPair[]

host

string

httpMethod

string

httpResponseCodes

ObservedInteger[]

httpResponseMessages

ObservedString[]

ipAddresses

ObservedString[]

ipBlocks

IpBlock[]

ipv4

ObservedBoolean[]

ipv6

ObservedBoolean[]

isRootUrl

boolean

languages

ObservedString[]

lastSeen

string (date-time)

location

ObservedLocation[]

nonHtmlFrames

ObservedBoolean[]

parkedPage

ObservedBoolean[]

redirectType

PageAssetRedirectType

The redirect type of a page

redirectUrls

ObservedString[]

referrer

string

resourceUrls

ResourceUrl[]

responseBodies

ObservedString[]

responseBodyHashSignatures

ObservedString[]

responseBodyMinhashSignatures

ObservedIntegers[]

responseHeaders

ObservedHeader[]

responseTimes

ObservedLong[]

rootUrl

ObservedBoolean

service

string

services

Service[]

siteStatus

string

sources

Source[]

sslCerts

SslCertAsset[]

sslServerConfig

SslServerConfig[]

successful

ObservedBoolean[]

titles

ObservedString[]

undirectedContent

ObservedBoolean[]

url

string (uri)

webComponents

WebComponent[]

windowNames

ObservedString[]

windows

ObservedBoolean[]

PageAssetRedirectType

The redirect type of a page

Value Description
httpHeader
metaRefresh
javascript
final

PageAssetResource

Name Type Description
asset

PageAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

page

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

PageCause

Name Type Description
cause

string

causeElementXPath

string

domChangeIndex

integer (int32)

location

string

loopDetected

boolean

possibleMatches

integer (int32)

version

integer (int32)

Port

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

port

integer (int32)

ReportAssetSnapshotRequest

A request body used to retrieve an asset report snapshot.

Name Type Description
labelName

string

The name of the label to retrieve a snapshot for.

metric

string

The metric to retrieve a snapshot for.

page

integer (int32)

The page to retrieve.

size

integer (int32)

The number of assets per page.

ReportAssetSnapshotResult

A snapshot of assets captured daily for the provided metric. Asset details only contain primary properties. Detailed asset data can be retrieved from the asset endpoints.

Name Type Description
assets

AssetPageResult

The page of assets that match the provided metric.

description

string

A description of what the metric represents.

displayName

string

The name of the metric.

labelName

string

The customer label that was filtered on, if one was provided.

metric

string

The unique metric name.

updatedAt

string (date-time)

The last time this asset data was updated on this metric.

Reputation

Name Type Description
cidr

string

firstSeen

string (date-time)

lastSeen

string (date-time)

listName

string

listUpdatedAt

string (date-time)

recent

boolean

threatType

string

trusted

boolean

ResourceUrl

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

recent

boolean

resources

DependentResource[]

url

string (uri)

ScanMetadata

Name Type Description
bannerMetadata

string

endScan

string (date-time)

port

integer (int32)

startScan

string (date-time)

Service

Name Type Description
count

integer (int64)

exceptions

ObservedString[]

firstSeen

string (date-time)

lastSeen

string (date-time)

port

integer (int32)

portStates

ObservedPortState[]

recent

boolean

scheme

string

sources

Source[]

sslCerts

SslCertAsset[]

webComponents

WebComponent[]

SoaRecord

Name Type Description
count

integer (int64)

email

string

firstSeen

string (date-time)

lastSeen

string (date-time)

nameServer

string

recent

boolean

serialNumber

integer (int64)

Source

Name Type Description
count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

reason

string

source

string

SslCertAsset

Name Type Description
certificateAuthority

boolean

count

integer (int64)

firstSeen

string (date-time)

invalidAfter

string (date-time)

invalidBefore

string (date-time)

issuerAlternativeNames

string[]

issuerCommonNames

string[]

issuerCountry

string[]

issuerLocality

string[]

issuerOrganizationalUnits

string[]

issuerOrganizations

string[]

issuerState

string[]

keyAlgorithm

string

keySize

integer (int32)

lastSeen

string (date-time)

organizationalUnits

string[]

organizations

string[]

recent

boolean

selfSigned

boolean

serialNumber

string

sha1

string

sigAlgName

string

sigAlgOid

string

sources

Source[]

subjectAlternativeNames

string[]

subjectCommonNames

string[]

subjectCountry

string[]

subjectLocality

string[]

subjectOrganizationalUnits

string[]

subjectOrganizations

string[]

subjectState

string[]

validationType

SslCertAssetValidationType

The validation type of a Ssl certificate

version

integer (int32)

SslCertAssetResource

Name Type Description
asset

SslCertAsset

asset

auditTrail

AuditTrailItem[]

The history of how this asset was pulled into the workspace through the discovery process.

createdDate

string (date-time)

The date this asset was first added to this workspace.

discoGroupName

string

The name of the DiscoGroup that brought added this asset to the workspace.

displayName

string

The name that can be used for display purposes.

externalId

string

An optional customer provided identifier for this asset.

id

string

The system generated unique id for the resource.

kind string:

sslCert

Discriminator property for AssetResource.

labels

string[]

Customer labels assigned to this asset.

name

string

The caller provided unique name for the resource.

reason

string

state

AssetState

The state of assets

updatedDate

string (date-time)

The date this asset was last updated for this workspace.

uuid

string (uuid)

Global UUID for the asset.

wildcard

boolean

An indicator of whether this asset represents a wildcard rollup of assets on this domain.

SslCertAssetValidationType

The validation type of a Ssl certificate

Value Description
domainValidation
organizationValidation
extendedValidation

SslServerConfig

Name Type Description
cipherSuites

string[]

count

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

sources

Source[]

tlsVersions

string[]

SubResourceIntegrityCheck

Name Type Description
causePageUrl

string

count

integer (int64)

crawlGuid

string

expectedHash

string

firstSeen

string (date-time)

lastSeen

string (date-time)

pageGuid

string

resourceGuid

string

violation

boolean

WebComponent

Name Type Description
count

integer (int64)

cve

Cve[]

endOfLife

integer (int64)

firstSeen

string (date-time)

lastSeen

string (date-time)

name

string

ports

Port[]

recent

boolean

ruleId

string[]

service

string

sources

Source[]

type

string

version

string