{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List Alert Subscribers API", "version": "v1" }, "items": [ { "info": { "name": "Alert Subscribers", "type": "folder" }, "items": [ { "info": { "name": "Subscribe a subscriber to alerts for a given Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lb/:lb_id/subscribe", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Subscribe an existing subscriber to alerts for a given Load Balancer." }, { "info": { "name": "Unsubscribe a subscriber from alerts for a given Load Balancer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lb/:lb_id/unsubscribe", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Unsubscribe a subscriber from alerts for a given Load Balancer. The subscriber is not deleted, and can be resubscribed in the future if necessary." }, { "info": { "name": "Delete a subscriber", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lb/subscription/:subscriber_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "subscriber_id", "value": "", "type": "path", "description": "Subscriber ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an existing subscriber, specified by its subscriber ID. Deleting a subscriber is permanent, and cannot be undone." }, { "info": { "name": "List all subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of subscribers in the response." }, { "name": "page", "value": "", "type": "query", "description": "The page number to return, from the paginated results." }, { "name": "page_size", "value": "", "type": "query", "description": "The number of items to return." }, { "name": "name", "value": "", "type": "query", "description": "Subscriber name to search for." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter subscribers by Organization ID." }, { "name": "project_id", "value": "", "type": "query", "description": "Filter subscribers by Project ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all subscribers to Load Balancer alerts. By default, returns all subscribers to Load Balancer alerts for the Organization associated with the authentication token used for the request." }, { "info": { "name": "Create a subscriber", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new subscriber, either with an email configuration or a webhook configuration, for a specified Scaleway Project." }, { "info": { "name": "Get a subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers/:subscriber_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "subscriber_id", "value": "", "type": "path", "description": "Subscriber ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about an existing subscriber, specified by its subscriber ID. Its full details, including name and email/webhook configuration, are returned in the response object." }, { "info": { "name": "Update a subscriber", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers/:subscriber_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "subscriber_id", "value": "", "type": "path", "description": "Subscriber ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of a given subscriber (e.g. name, webhook configuration, email configuration), specified by its subscriber ID." } ] } ], "bundled": true }