Skip to content

Mark all notifications of your organization as read

POST
/organization/notifications/clear

Mark all notifications of your organization as read.

Authorizations

Responses

200

A collection of notifications

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema
object
count
required

Number of items returned in the result.

integer
Example:
1
notifications
Array<object>

A notification describing describing events of a database.

object
id
string
format: uuid
createdAt
string
format: date-time
message
string
Example:
database_tps_threshold_breach_80pct
status
string
Allowed values:
NOTIFICATION_STATUS_READ
NOTIFICATION_STATUS_UNREAD
source

Source of the event e.g., db, org, user, … for facilitating further actions

object
databaseId
string
format: uuid
Example
Content type: application/json
{
"count": 1,
"notifications":
"id": "string",
"createdAt": "string",
"message": "database_tps_threshold_breach_80pct",
"status": "NOTIFICATION_STATUS_READ",
"source":
"databaseId": "string"
}
}
]
}

401

Access token is missing or invalid

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{
"code": "invalid_token",
"message": "The access token expired."
}

403

Permission denied

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{
"code": "string",
"message": "string"
}

500

Internal Server Error

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{
"code": "string",
"message": "string"
}
Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?