Sign in
correlate

Create a neighborhood graph around a start object to a given depth.

Changed on

Specify a set of start objects, as queries or serialized objects, and a depth for the neighborhood search. Returns a graph of all paths with depth or less edges leading from start objects.

post/graphs/neighbours

Request

  • Base URL: /api/v1alpha1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1alpha1/graphs/neighbours
  • Auth: none declared

Query parameters

rulesboolean

If true include rule names in graph edges.

resultsboolean

If true include full JSON results with each Query.

errorsboolean

If true include non-fatal error messages.

Request body

depthinteger required

Maximum number of correlation steps to follow from the start. Depth 1 returns direct correlations only.

Example request

{
  "start": {
    "constraint": {
      "end": "2017-07-21T17:32:28.1341231Z"
    },
    "queries": [
      "k8s:Pod:{\"namespace\":\"default\",\"name\":\"my-pod\"}"
    ]
  }
}

Response

OK

Changes

  • 11b49ec1cf15Revision changes
    • ○

      added the optional property ////// to the response with the status

    • ○

      added the optional property //// to the response with the status

  • b8ef963b37d6Revision changes
    • ●

      removed the request property //////////

    • ○

      endpoint deprecated