Skip to main content
PUT
/
api
/
v1
/
score
/
{index}
/
{uid}
Update score change
curl --request PUT \
  --url https://api.example.com/api/v1/score/{index}/{uid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tags": [
    "<string>"
  ]
}
'
{
  "uid": "<string>",
  "index": "<string>",
  "timestamp": 123,
  "i": 123,
  "type": "<string>",
  "organisationId": 123,
  "licenseId": 123,
  "licenseInstanceId": 123,
  "tenantId": 123,
  "projectId": 123,
  "contractId": 123,
  "txHash": "<string>",
  "detectorSchemaName": "<string>",
  "alertId": "<string>",
  "monitorId": "<string>",
  "alertName": "<string>",
  "alertMessage": "<string>",
  "numericSeverity": 123,
  "severity": "<string>",
  "tags": [
    "<string>"
  ],
  "meta": {},
  "scoreGroup": "<string>",
  "score": 123,
  "scoreChange": 123,
  "key": "<string>",
  "value": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.extractor.live/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authentication

Path Parameters

​
index
string
required
​
uid
string
required

Query Parameters

​
refresh
enum<string>

If 'true', OpenSearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes.

Available options:
WaitFor,
True,
False

Body

application/json
​
tags
string[]
required

Tag list of the alert, could be viewed or empty. Values: viewed

Response

200 - application/json

OK

​
uid
string

UID of the document

​
index
string

Index of the document

​
timestamp
integer<int64>

Event timestamp

​
i
integer<int32>

Index of the document

​
type
string

Type of the events with same timestamp

​
organisationId
integer<int64>

Id of the organisation that provided the license

​
licenseId
integer<int64>

Id of the license that provided score formula

​
licenseInstanceId
integer<int64>

Id of the license instance that provided score formula

​
tenantId
integer<int64>

Id of the tenant that provided alert

​
projectId
integer<int64>

Id of the project that provided alert

​
contractId
integer<int64>

Id of the contract that provided alert

​
txHash
string

Hash of the transaction, that produced this event

​
detectorSchemaName
string

Detector schema name of the score change

​
alertId
string

Id of the alert that triggered this score change

​
monitorId
string

Monitor id for deduplication of this score change

​
alertName
string

Name of the alert that triggered this score change

​
alertMessage
string

Message of the alert that triggered this score change

​
numericSeverity
number<double>

Numeric severity of the alert that triggered this score change

​
severity
string

Severity of the alert that triggered this score change

​
tags
string[]

Tag list of the alert, could be viewed or empty

​
meta
object

Metadata of the alert, that produced this score change

​
scoreGroup
string

Score group of the score

​
score
number<double>

Total score

​
scoreChange
number<double>

Change of the score compared with previous event

​
key
string

Key of the score data

​
value
number<double>

Value of the score data