List whoisRecords

Article
02/09/2024

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Note

The Microsoft Graph API for Microsoft Defender Threat Intelligence requires an active Defender Threat Intelligence Portal license and API add-on license for the tenant.

Get a list of whoisRecord objects.

Note: You must include the $search query parameter in the request URL for this API.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	ThreatIntelligence.Read.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	ThreatIntelligence.Read.All	Not available.

HTTP request

GET /security/threatIntelligence/whoisRecords?$search="{value}"

Optional query parameters

This method supports the $count, $orderby, $search, $select, $skip, and $top OData query parameters to help customize the response. For general information, see OData query parameters.

Name	Description
$count	`$count` is supported to return a holistic count of the number of whoisRecord objects. `$count` is supported as a query parameter (`?$count=true`) or as a path parameter (`/$count`).
$orderby	`$orderby` supports some properties of the whoisRecord resource. For details, see Supported properties with $orderby.
$search	`$search` is required in the request URL of this API. The API currently only supports searching by one field in a call. For details, see Supported properties with $search.
$select	`$select` is supported to limit the properties returned in this query.
$skip	`$skip` is supported to skip over elements in pages. Combine with `$top` to perform pagination or use the `@odata.nextLink` for server-side pagination.
$top	`$top` is supported to limit the number of elements per page. Combine with `$skip` to perform pagination or use the `@odata.nextLink` for server-side pagination.

Supported properties with $orderby

The following properties can be used for $orderby calls.

Property	Example	Notes
expirationDateTime	`$orderby=expirationDateTime desc`
host/id	`$orderby=host/id asc`	The full path is required for `$orderby` usage.
registrationDateTime	`$orderby=registrationDateTime desc`

Supported properties with $search

The following properties can be used for $search calls.

Property	Example	Notes
abuse	`$search="abuse/address/state:WA"`	The `$search` must target a specific field of the whoisContact.
admin	`$search="admin/address/state:WA"`	The `$search` must target a specific field of the whoisContact.
billing	`$search="billing/address/state:WA"`	The `$search` must target a specific field of the whoisContact.
nameservers	`$search="nameservers/host/id:contoso.com"`	The `$search` must search against as specific host ID.
noc	`$search="noc/address/state:WA"`	The `$search` must target a specific field of the whoisContact.
registrant	`$search="registrant/address/state:WA"`	The `$search` must target a specific field of the whoisContact.
registrar	`$search="registrar/address/state:WA"`	The `$search` must target a specific field of the whoisContact.
technical	`$search="technical/address/state:WA"`	The `$search` must target a specific field of the whoisContact.
zone	`$search="zone/address/state:WA"`	The `$search` must target a specific field of the whoisContact.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a microsoft.graph.security.whoisRecord object in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/security/threatIntelligence/whoisRecords?$search="admin/address/state:WA&$orderby=registrationDateTime desc"


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.ThreatIntelligence.WhoisRecords.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Search = "\"admin/address/state:WA";
	requestConfiguration.QueryParameters.Orderby = new string []{ "registrationDateTime desc"" };
});

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta security threat-intelligence whois-records list --search ""admin/address/state:WA" --orderby "registrationDateTime desc""

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphsecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/security"
	  //other-imports
)


requestSearch := "\"admin/address/state:WA"

requestParameters := &graphsecurity.SecurityThreatIntelligenceWhoisRecordsRequestBuilderGetQueryParameters{
	Search: &requestSearch,
	Orderby: [] string {"registrationDateTime desc""},
}
configuration := &graphsecurity.SecurityThreatIntelligenceWhoisRecordsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
whoisRecords, err := graphClient.Security().ThreatIntelligence().WhoisRecords().Get(context.Background(), configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.security.WhoisRecordCollectionResponse result = graphClient.security().threatIntelligence().whoisRecords().get(requestConfiguration -> {
	requestConfiguration.queryParameters.search = "\"admin/address/state:WA";
	requestConfiguration.queryParameters.orderby = new String []{"registrationDateTime desc""};
});

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Security\ThreatIntelligence\WhoisRecords\WhoisRecordsRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new WhoisRecordsRequestBuilderGetRequestConfiguration();
$queryParameters = WhoisRecordsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->search = "\"admin/address/state:WA";
$queryParameters->orderby = ["registrationDateTime desc""];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->security()->threatIntelligence()->whoisRecords()->get($requestConfiguration)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Security

Get-MgBetaSecurityThreatIntelligenceWhoisRecord -Search '"admin/address/state:WA"' -Sort "registrationDateTime desc"

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


from msgraph import GraphServiceClient
from msgraph.generated.security.threat_intelligence.whois_records.whois_records_request_builder import WhoisRecordsRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = WhoisRecordsRequestBuilder.WhoisRecordsRequestBuilderGetQueryParameters(
		search = "\"admin/address/state:WA",
		orderby = ["registrationDateTime desc""],
)

request_configuration = WhoisRecordsRequestBuilder.WhoisRecordsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.security.threat_intelligence.whois_records.get(request_configuration = request_configuration)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.security.whoisRecord",
      "id": "Y29udG9zby5jb20kJDY5NjQ3ODEyMDc3NDY1NzI0MzM=",
      "expirationDateTime": "2023-08-31T00:00:00Z",
      "registrationDateTime": "2022-07-30T09:43:19Z",
      "firstSeenDateTime": null,
      "lastSeenDateTime": null,
      "lastUpdateDateTime": "2023-06-24T08:34:15.984Z",
      "billing": null,
      "noc": null,
      "zone": null,
      "whoisServer": "rdap.markmonitor.com",
      "domainStatus": "client update prohibited,client transfer prohibited,client delete prohibited",
      "rawWhoisText": "Registrar: \n  Handle: 1891582_DOMAIN_COM-VRSN\n  LDH Name: contoso.com\n  Nameserver: \n    LDH Name: ns1.contoso.com\n    Event: \n      Action: last changed\n...",
      "abuse": {
        "email": "noreply@contoso.com",
        "name": null,
        "organization": null,
        "telephone": "+1.5555555555",
        "fax": null,
        "address": {
          "city": null,
          "countryOrRegion": null,
          "postalCode": null,
          "state": null,
          "street": null,
          "type": "unknown"
        }
      },
      "admin": {
        "email": "noreply@contoso.com",
        "name": "Domain Administrator",
        "organization": "Contoso Org",
        "telephone": "+1.5555555555",
        "fax": "+1.5555555555",
        "address": {
          "city": "Redmond",
          "countryOrRegion": "US",
          "postalCode": "98052",
          "state": "WA",
          "street": "123 Fake St.",
          "type": "unknown"
        }
      },
      "registrar": {
        "email": null,
        "name": null,
        "organization": "MarkMonitor Inc.",
        "telephone": null,
        "fax": null,
        "address": null
      },
      "registrant": {
        "email": "noreply@contoso.com",
        "name": "Domain Administrator",
        "organization": "Contoso Corporation",
        "telephone": "+1.5555555555",
        "fax": "+1.5555555555",
        "address": {
          "city": "Redmond",
          "countryOrRegion": "US",
          "postalCode": "98052",
          "state": "WA",
          "street": "123 Fake St.",
          "type": "unknown"
        }
      },
      "technical": {
        "email": "noreply@contoso.com",
        "name": "Hostmaster",
        "organization": "Contoso Corporation",
        "telephone": "+1.5555555555",
        "fax": "+1.5555555555",
        "address": {
          "city": "Redmond",
          "countryOrRegion": "US",
          "postalCode": "98052",
          "state": "WA",
          "street": "123 Fake St.",
          "type": "unknown"
        }
      },
      "nameservers": [
        {
          "firstSeenDateTime": null,
          "lastSeenDateTime": null,
          "host": {
            "id": "ns1.contoso-dns.com"
          }
        },
        {
          "firstSeenDateTime": null,
          "lastSeenDateTime": null,
          "host": {
            "id": "ns2.contoso-dns.com"
          }
        },
        {
          "firstSeenDateTime": null,
          "lastSeenDateTime": null,
          "host": {
            "id": "ns3.contoso-dns.com"
          }
        },
        {
          "firstSeenDateTime": null,
          "lastSeenDateTime": null,
          "host": {
            "id": "ns4.contoso-dns.com"
          }
        }
      ],
      "host": {
        "id": "contoso.com"
      }
    }
  ]
}

Share via

List whoisRecords

Permissions

HTTP request

Optional query parameters

Supported properties with $orderby

Supported properties with $search

Request headers

Request body

Response

Examples

Request

Response

Feedback

Feedback

Additional resources