List hostPairs

Namespace: microsoft.graph.security

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 the list of hostPair resources associated with a host, where that host is either the parent or the child.

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/hosts/{hostId}/hostPairs

Optional query parameters

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

The following properties can be used for $filter calls.

Property	Example	Notes
All hostPair properties	$filter=(linkKind eq 'redirect')	Use the name as it appears in the hostPair resource.
childHost/id	$filter=(childHost/id eq 'contoso.com')	Full path is required for $filter usage.
parentHost/id	$filter=(parentHost/id in ('contoso.com','downstream.consoso.com'))	Full path is required for $filter usage.

The following properties can be used for $orderby calls.

Property	Example	Notes
firstSeenDateTime	$orderby=firstSeenDateTime desc
lastSeenDateTime	$orderby=lastSeenDateTime asc

The following properties can be used for $select calls.

Property	Example	Notes
All hostPair properties	$select=id,firstSeenDateTime	Use the name as it appears in the hostPair resource.
parentHost	$select=parentHost	Doesn't support selecting on nested properties (for example parentHost/id).
childHost	$select=childHost	Doesn't support selecting on nested properties (for example childHost/id).

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 collection of microsoft.graph.security.hostPair objects in the response body.

Examples

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/v1.0/security/threatIntelligence/hosts/contoso.com/hostPairs

C#

// 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.Hosts["{host-id}"].HostPairs.GetAsync();

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

CLI

mgc security threat-intelligence hosts host-pairs list --host-id {host-id}

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

Go

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

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
hostPairs, err := graphClient.Security().ThreatIntelligence().Hosts().ByHostId("host-id").HostPairs().Get(context.Background(), nil)

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

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.models.security.HostPairCollectionResponse result = graphClient.security().threatIntelligence().hosts().byHostId("{host-id}").hostPairs().get();

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let hostPairs = await client.api('/security/threatIntelligence/hosts/contoso.com/hostPairs')
	.get();

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->security()->threatIntelligence()->hosts()->byHostId('host-id')->hostPairs()->get()->wait();

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

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.security.threat_intelligence.hosts.by_host_id('host-id').host_pairs.get()

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.hostPair",
      "id": "ZmluYWxSZWRpcmVjdCQkY29udG9zby5jb20kJGNvbnRvc28uY29tJCRjb250b3NvLmNvbQ==",
      "firstSeenDateTime": "2022-05-11T01:27:14.187Z",
      "lastSeenDateTime": "2023-06-23T06:33:31.493Z",
      "linkKind": "finalRedirect",
      "parentHost": {
        "id": "contoso.com"
      },
      "childHost": {
        "id": "contoso.com"
      }
    }
  ]
}