Method: findingsGraph.initializeGraph

Full name: projects.locations.instances.findingsGraph.initializeGraph

Initialize a graph from a resource such as a detection or an entity.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{name}:initializeGraph

Path parameters

Parameters
name

string

Required. The resource name of the FindingsGraph resource. Format: projects/{project}/locations/{location}/instances/{instance}/findingsGraph

Query parameters

Parameters
nodeSource

object (NodeSource)

Required. An identifier for the detection/alert or entity to show associations for in the response.
timeRange

object (Interval)

Required. The time range that the graph exploration is limited to. IDs for nodes that can be used in subsequent calls to expand the nodes will be tied to this time range, so changing the graph time range requires initializing the graph again.
params

object (ExplorationOptions)

Optional. The options to initialize the graph.

Request body

The request body must be empty.

Response body

Response message to initialize a graph from a resource and a time range.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "root_node": {
    object (Node)
  },
  "graph": {
    object (Graph)
  },
  "next_page_token": string
}
Fields
root_node

object (Node)

The root node of the whole graph generated by the given NodeSource.
graph

object (Graph)

A graph composed of nodes and the edges between these nodes and the root node.
next_page_token

string

A token, which can be sent as page_token to retrieve the graph composed of the next page of nodes. If this field is omitted, there are no subsequent pages. Pagination applies to the nodes in the response and the edges that touch those nodes.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.findingsGraphs.initializeGraph

For more information, see the IAM documentation.

NodeSource

A node source which tells which resource is an individual node is generated from. For a detection node, it is the detection id. For an entity node, it is the entity resource name.

JSON representation 
{

  // Union field source can be only one of the following:
  "detection_id": string,
  "entity": string
  // End of list of possible types for union field source.
}
Fields

Union field source.

source can be only one of the following:
detection_id

string

A detection id.
entity

string

The resource name of an entity. Format: projects/{project}/locations/{location}/instances/{instance}/entities/{entity}