{ "opencollection": "1.0.0", "info": { "name": "YugabyteDB Aeon REST Access Keys Alerts API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Alerts", "type": "folder" }, "items": [ { "info": { "name": "YugabyteDB Anywhere List All Alert Channel Templates", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channel_templates", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get Alert Channel Templates", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channel_templates/:acType", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "acType", "value": "DEFAULT", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Set Alert Channel Templates", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channel_templates/:acType", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "acType", "value": "DEFAULT", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Delete Alert Channel Templates", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channel_templates/:acType", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "acType", "value": "DEFAULT", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere List All Alert Channels", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channels", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Create an Alert Channel", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channels", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get an Alert Channel", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channels/:acUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "acUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Update an Alert Channel", "type": "http" }, "http": { "method": "PUT", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channels/:acUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "acUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Delete an Alert Channel", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_channels/:acUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "acUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Create an Alert Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_configurations", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get Filtered List of Alert Configurations", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_configurations/list", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere List All Alert Configurations (paginated)", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_configurations/page", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get an Alert Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_configurations/:configurationUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "configurationUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Update an Alert Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_configurations/:configurationUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "configurationUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Delete an Alert Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_configurations/:configurationUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "configurationUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Send Test Alert for Alert Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_configurations/:configurationUUID/test_alert", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "configurationUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere List Alert Destinations", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_destinations", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Create an Alert Destination", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_destinations", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get an Alert Destination", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_destinations/:adUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "adUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Update an Alert Destination", "type": "http" }, "http": { "method": "PUT", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_destinations/:adUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "adUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Delete an Alert Destination", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_destinations/:adUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "adUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Prepare Alert Notification Preview", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_notification_preview", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get Alert Template Settings - Deprecated", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_template_settings", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Deprecated since YBA version 2.20.0.0.

" }, { "info": { "name": "YugabyteDB Anywhere Create or Update Alert Template Settings List - Deprecated", "type": "http" }, "http": { "method": "PUT", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_template_settings", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deprecated since YBA version 2.20.0.0.

" }, { "info": { "name": "YugabyteDB Anywhere Delete an Alert Template Settings - Deprecated", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_template_settings/:settingsUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "settingsUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ] }, "docs": "Deprecated since YBA version 2.20.0.0.

" }, { "info": { "name": "YugabyteDB Anywhere List Alert Template Variables", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_template_variables", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Create or Update Alert Template Variables", "type": "http" }, "http": { "method": "PUT", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_template_variables", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Delete an Alert Template Variables", "type": "http" }, "http": { "method": "DELETE", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_template_variables/:variableUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "variableUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get Filtered List of Alert Configuration Templates", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alert_templates", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere List All Alerts", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alerts", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Acknowledge All Alerts - Deprecated", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alerts/acknowledge", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deprecated since YBA version 2.8.0.0.

" }, { "info": { "name": "YugabyteDB Anywhere List Active Alerts - Deprecated", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alerts/active", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "Deprecated since YBA version 2.8.0.0.

" }, { "info": { "name": "YugabyteDB Anywhere Count Alerts", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alerts/count", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere List Alerts (paginated)", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alerts/page", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Get Details of an Alert", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alerts/:alertUUID", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "alertUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" } ] }, "docs": "WARNING: This is a preview API that could change." }, { "info": { "name": "YugabyteDB Anywhere Acknowledge an Alert", "type": "http" }, "http": { "method": "POST", "url": "https://cloud.yugabyte.com/api/public/v1/api/v1/customers/:cUUID/alerts/:alertUUID/acknowledge", "params": [ { "name": "cUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "alertUUID", "value": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "type": "path" }, { "name": "request", "value": "example-request", "type": "query" } ] }, "docs": "WARNING: This is a preview API that could change." } ] } ], "bundled": true }