Notifications

Get all notifications

get

Returns all notifications.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0

pageSizenumberOptional

The numbers of items to return

Example: 20

Responses

200

Successful operation. Returns notifications and count.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/notifications

HTTPcURLJavaScriptPython

GET /api/v1/notifications HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T14:40:28.853Z",
    "updateDate": "2026-03-25T14:40:28.853Z",
    "userId": "69b00a309fe1408d21bea39a",
    "title": "Policy published",
    "type": "SUCCESS",
    "action": "POLICY_CONFIGURATION",
    "result": "69b83f18cd6b7c4adf4139bc",
    "message": "Policy 69b83f18cd6b7c4adf4139bc published",
    "read": false,
    "old": false,
    "id": "69c3f3dc0c86dc7119046b9f"
  },
  {
    "createDate": "2026-03-10T13:15:21.260Z",
    "updateDate": "2026-03-10T13:15:21.260Z",
    "userId": "69b00a309fe1408d21bea39a",
    "title": "Import schema file",
    "type": "ERROR",
    "message": "Cannot destructure property 'category' of '(intermediate value)' as it is null.",
    "read": false,
    "old": false,
    "id": "69b01969b8a32e85cd3714bd"
  }
]

Get new notifications

get

Returns new notifications.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation. Returns new notifications.

application/json

idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5

createDatestringRequired

Creation date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z

updateDatestringRequired

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z

userIdstringRequired

User ID who owns this notification

Example: 69aeb71ef8c5b278e3bab4e5

titlestringRequired

Notification title (e.g. "Policy published", "Schema created")

Example: Policy published

messagestringRequired

Detailed notification message

Example: Policy 69b83f18cd6b7c4adf4139bc published

typestring · enumRequired

Notification type

Example: SUCCESSPossible values:

actionstring · enumRequired

Action that triggered the notification (used for navigation in UI)

Example: POLICY_CONFIGURATIONPossible values:

resultobjectRequired

Result ID (e.g. policy ID, schema ID) for navigation

Example: 69aeb71ef8c5b278e3bab4e5

readbooleanRequired

Whether the notification has been read

Example: false

oldbooleanRequired

Whether the notification is old (already shown to user)

Example: false

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/notifications/new

HTTPcURLJavaScriptPython

GET /api/v1/notifications/new HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T14:40:28.853Z",
    "updateDate": "2026-03-25T14:40:28.853Z",
    "userId": "69b00a309fe1408d21bea39a",
    "title": "Policy published",
    "type": "SUCCESS",
    "action": "POLICY_CONFIGURATION",
    "result": "69b83f18cd6b7c4adf4139bc",
    "message": "Policy 69b83f18cd6b7c4adf4139bc published",
    "read": false,
    "old": false,
    "id": "69c3f3dc0c86dc7119046b9f"
  },
  {
    "createDate": "2026-03-10T13:15:21.260Z",
    "updateDate": "2026-03-10T13:15:21.260Z",
    "userId": "69b00a309fe1408d21bea39a",
    "title": "Import schema file",
    "type": "ERROR",
    "message": "Cannot destructure property 'category' of '(intermediate value)' as it is null.",
    "read": false,
    "old": false,
    "id": "69b01969b8a32e85cd3714bd"
  }
]

Get progresses

get

Returns progresses.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation. Returns progresses.

application/json

idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5

createDatestringRequired

Creation date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z

updateDatestringRequired

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z

userIdstringRequired

User ID who initiated the action

Example: 69aeb71ef8c5b278e3bab4e5

actionstringRequired

Action being tracked (e.g. "Publish policy")

Example: Publish policy

messagestringRequired

Current progress message

Example: Publishing schemas...

progressnumberRequired

Progress percentage (0-100)

Example: 50

typestring · enumRequired

Progress type

Example: INFOPossible values:

taskIdstringRequired

Associated task ID

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get

/notifications/progresses

HTTPcURLJavaScriptPython

GET /api/v1/notifications/progresses HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "action": "string",
    "message": "string",
    "progress": 0,
    "type": "string",
    "taskId": "69aeb71ef8c5b278e3bab4e5"
  }
]

Read all notifications

post

Marks all notifications as read and returns them.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation. Returns notifications.

application/json

idstringRequired

Internal database identifier

Example: 69aeb71ef8c5b278e3bab4e5

createDatestringRequired

Creation date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z

updateDatestringRequired

Last update date in ISO 8601 format

Example: 2026-03-03T17:25:53.312Z

userIdstringRequired

User ID who owns this notification

Example: 69aeb71ef8c5b278e3bab4e5

titlestringRequired

Notification title (e.g. "Policy published", "Schema created")

Example: Policy published

messagestringRequired

Detailed notification message

Example: Policy 69b83f18cd6b7c4adf4139bc published

typestring · enumRequired

Notification type

Example: SUCCESSPossible values:

actionstring · enumRequired

Action that triggered the notification (used for navigation in UI)

Example: POLICY_CONFIGURATIONPossible values:

resultobjectRequired

Result ID (e.g. policy ID, schema ID) for navigation

Example: 69aeb71ef8c5b278e3bab4e5

readbooleanRequired

Whether the notification has been read

Example: false

oldbooleanRequired

Whether the notification is old (already shown to user)

Example: false

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post

/notifications/read/all

HTTPcURLJavaScriptPython

POST /api/v1/notifications/read/all HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-25T14:40:28.853Z",
    "updateDate": "2026-03-25T14:40:28.853Z",
    "userId": "69b00a309fe1408d21bea39a",
    "title": "Policy published",
    "type": "SUCCESS",
    "action": "POLICY_CONFIGURATION",
    "result": "69b83f18cd6b7c4adf4139bc",
    "message": "Policy 69b83f18cd6b7c4adf4139bc published",
    "read": false,
    "old": false,
    "id": "69c3f3dc0c86dc7119046b9f"
  },
  {
    "createDate": "2026-03-10T13:15:21.260Z",
    "updateDate": "2026-03-10T13:15:21.260Z",
    "userId": "69b00a309fe1408d21bea39a",
    "title": "Import schema file",
    "type": "ERROR",
    "message": "Cannot destructure property 'category' of '(intermediate value)' as it is null.",
    "read": false,
    "old": false,
    "id": "69b01969b8a32e85cd3714bd"
  }
]

Delete notifications up to this point

delete

Returns deleted notifications count.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

notificationIdstringRequired

Notification Identifier

Example: 9db028d2-03ad-4d49-a178-cf4b67f8c147

Responses

200

Successful operation. Returns deleted notifications count.

application/json

numberOptional

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

delete

/notifications/delete/{notificationId}

HTTPcURLJavaScriptPython

DELETE /api/v1/notifications/delete/{notificationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content