Skip to content

Latest commit

 

History

History
152 lines (121 loc) · 6.02 KB

security-host-list-childhostpairs.md

File metadata and controls

152 lines (121 loc) · 6.02 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
List childHostPairs
Get the list of hostPair resources associated with a host, where that host is the parent and has an outgoing pairing to a child.
jakedavies-microsoft
medium
security
apiPageType

List childHostPairs

Namespace: microsoft.graph.security

[!INCLUDE beta-disclaimer]

[!INCLUDE threatintelligence-api-disclaimer]

Get the list of hostPair resources associated with a specified host, where that host is the parent and has an outgoing pairing to a child.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

GET /security/threatIntelligence/hosts/{hostId}/childHostPairs

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 requried 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
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 Does not support selecting on nested properties (for example parentHost/id).
childHost $select=childHost Does not 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/beta/security/threatIntelligence/hosts/contoso.com/childHostPairs

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

CLI

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE 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": "microsoft.com"
      },
      "childHost": {
        "id": "contoso.com"
      }
    }
  ]
}