Security Alerts

Get Security Alerts

Get all Security Alerts in a configuration

GET/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Response

200422

Security Alerts retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": []
}

Modify Security Alerts

Update an existing set of Security Alerts for a configuration

PUT/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Body

application/json

Security Alerts document

Response

200422

Security Alerts updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([]),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create Security Alerts

Create complete set of Security Alerts for a configuration

POST/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Body

application/json

Security Alerts document

Response

201422

Security Alerts created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([]),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Delete Security Alerts

Delete all Security Alerts in a configuration

DELETE/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Response

200422

Security Alerts deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

Get single Alert

Get an individual Alert from the specified configuration

GET/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

200422

Alert retrieved successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Modify a single Alert

Update an individual Alert within a configuration

PUT/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

application/json

any

Response

200422

Alert updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create single Alert

Create an individual Alert within a configuration

POST/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

application/json

any

Response

201422

Alert created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Delete single Alert

Delete an individual Alert from the specified configuration

DELETE/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

200422

Alert deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

Get Security Alerts version list

Get list of versions of Security Alerts in a configuration

GET/api/v4.0/conf/{config}/security-alerts/versions

Path parameters

config*Config

Response

200422

Security Alerts version list retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2024-11-21T06:47:58.259Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Security Alerts

Get a specific version of an Alert

GET/api/v4.0/conf/{config}/security-alerts/versions/{version}

Path parameters

config*Config

version*Version

Response

200422

Alert version retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": []
}

Revert Security Alerts to the specified version

Set a previous Security Alerts version to be the current one

PUT/api/v4.0/conf/{config}/security-alerts/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

200422

Security Alerts reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}