Alert
List alerts¶
GET/api/v2/databases/{database}/schemas/{schema}/alerts
List alerts
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Path Parameters¶
| Parameter | Description |
|---|---|
| database string | Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases. |
| schema | Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database. |
Query Parameters¶
| Parameter | Description |
|---|---|
| like string | Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
| startsWith string | Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
| showLimit integer | Query parameter to limit the maximum number of rows returned by a command. |
| fromName string | Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
Response¶
| Code | Description |
|---|---|
| 200 | successful |
| 202 | Successfully accepted the request, but it is not completed yet. |
Create an alert¶
POST/api/v2/databases/{database}/schemas/{schema}/alerts
Create an alert
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| createMode string | Query parameter allowing support for different modes of resource creation. Possible values include:
|
Response¶
| Code | Description |
|---|---|
| 200 | Successful request. |
| 202 |
Fetch an alert¶
GET/api/v2/databases/{database}/schemas/{schema}/alerts/{name}
Fetch an alert
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Path Parameters¶
| Parameter | Description |
|---|---|
| name | Identifier (i.e. name) for the resource. |
Response¶
| Code | Description |
|---|---|
| 200 | successful |
| 202 |
Delete an alert¶
DELETE/api/v2/databases/{database}/schemas/{schema}/alerts/{name}
Delete an alert
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| ifExists boolean | Query parameter that specifies how to handle the request for a resource that does not exist:
|
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |
Create a new alert by cloning from the specified resource¶
POST/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:clone
Create a new alert by cloning from the specified resource
For more information
Go to the SQL command page to view more information about arguments, options, privileges requirements, and usage guidelines.
Query Parameters¶
| Parameter | Description |
|---|---|
| targetDatabase string | Database of the newly created resource. Defaults to the source's database |
| targetSchema string | Schema of the newly created resource. Defaults to the source's schema |
Response¶
| Code | Description |
|---|---|
| 200 | |
| 202 |