NFnforgeio
correlations

Add correlation.

post/datasources/uid/{sourceUID}/correlations

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/datasources/uid/{sourceUID}/correlations
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

sourceUIDstring required

Request body

descriptionstring

Optional description of the correlation

labelstring

Optional label identifying the correlation

targetUIDstring

Target data source UID to which the correlation is created. required if config.type = query

Example request

{
  "config": {
    "field": "message",
    "target": {
      "expr": "job=app"
    }
  },
  "description": "Logs to Traces",
  "label": "My label",
  "targetUID": "PE1C5CBDA0504A6A3"
}

Response

(empty)

messagestring

Example response

{
  "message": "Correlation created",
  "result": {
    "config": {
      "field": "message",
      "target": {
        "expr": "job=app"
      }
    },
    "description": "Logs to Traces",
    "label": "My Label",
    "sourceUID": "d0oxYRg4z",
    "targetUID": "PE1C5CBDA0504A6A3",
    "uid": "50xhMlg9k"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.