The Alert Subscribers object. It represents a subscription to alerts about Scaleway incidents impacting a given Load Balancer. Use this endpoint to create subscribers (email addresses or webhooks), subscribe / unsubscribe them to alerts for a particular Load Balancer, and update, list, get and delete subscribers.
Subscribe a subscriber to alerts for a given Load Balancer
Subscribe an existing subscriber to alerts for a given Load Balancer.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
Subscribe a subscriber to alerts for a given Load Balancer › Request Body
subscriber_idSubscriber ID.
Subscribe a subscriber to alerts for a given Load Balancer › Responses
idUnderlying Instance ID.
nameLoad Balancer name.
descriptionLoad Balancer description.
statusLoad Balancer status.
List of underlying Instances.
organization_idScaleway Organization ID.
project_idScaleway Project ID.
List of IP addresses attached to the Load Balancer.
tagsLoad Balancer tags.
frontend_countNumber of frontends the Load Balancer has.
backend_countNumber of backends the Load Balancer has.
typeLoad Balancer offer type.
Subscriber information.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on client side.
created_atDate on which the Load Balancer was created. (RFC 3339 format)
updated_atDate on which the Load Balancer was last updated. (RFC 3339 format)
private_network_countNumber of Private Networks attached to the Load Balancer.
route_countNumber of routes configured on the Load Balancer.
zoneThe zone the Load Balancer is in.
regionThe region the Load Balancer is in.
Unsubscribe a subscriber from alerts for a given Load Balancer
Unsubscribe a subscriber from alerts for a given Load Balancer. The subscriber is not deleted, and can be resubscribed in the future if necessary.
path Parameters
zoneThe zone you want to target
lb_idLoad Balancer ID.
Unsubscribe a subscriber from alerts for a given Load Balancer › Responses
idUnderlying Instance ID.
nameLoad Balancer name.
descriptionLoad Balancer description.
statusLoad Balancer status.
List of underlying Instances.
organization_idScaleway Organization ID.
project_idScaleway Project ID.
List of IP addresses attached to the Load Balancer.
tagsLoad Balancer tags.
frontend_countNumber of frontends the Load Balancer has.
backend_countNumber of backends the Load Balancer has.
typeLoad Balancer offer type.
Subscriber information.
ssl_compatibility_levelDetermines the minimal SSL version which needs to be supported on client side.
created_atDate on which the Load Balancer was created. (RFC 3339 format)
updated_atDate on which the Load Balancer was last updated. (RFC 3339 format)
private_network_countNumber of Private Networks attached to the Load Balancer.
route_countNumber of routes configured on the Load Balancer.
zoneThe zone the Load Balancer is in.
regionThe region the Load Balancer is in.
Delete a subscriber
Delete an existing subscriber, specified by its subscriber ID. Deleting a subscriber is permanent, and cannot be undone.
path Parameters
zoneThe zone you want to target
subscriber_idSubscriber ID.
Delete a subscriber › Responses
List all subscribers
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.
path Parameters
zoneThe zone you want to target
query Parameters
order_bySort order of subscribers in the response.
pageThe page number to return, from the paginated results.
page_sizeThe number of items to return.
nameSubscriber name to search for.
organization_idFilter subscribers by Organization ID.
project_idFilter subscribers by Project ID.
List all subscribers › Responses
List of subscriber objects.
total_countThe total number of objects.
Create a subscriber
Create a new subscriber, either with an email configuration or a webhook configuration, for a specified Scaleway Project.
path Parameters
zoneThe zone you want to target
Create a subscriber › Request Body
nameSubscriber name.
Email address configuration.
WebHook URI configuration.
project_idProject ID to create the subscriber in.
organization_idOrganization ID to create the subscriber in.
Create a subscriber › Responses
idSubscriber ID.
nameSubscriber name.
Email address of subscriber.
Webhook URI of subscriber.
Get a subscriber
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.
path Parameters
zoneThe zone you want to target
subscriber_idSubscriber ID.
Get a subscriber › Responses
idSubscriber ID.
nameSubscriber name.
Email address of subscriber.
Webhook URI of subscriber.
Update a subscriber
Update the parameters of a given subscriber (e.g. name, webhook configuration, email configuration), specified by its subscriber ID.
path Parameters
zoneThe zone you want to target
subscriber_idSubscriber ID.
Update a subscriber › Request Body
nameSubscriber name.
Email address configuration.
Webhook URI configuration.
Update a subscriber › Responses
idSubscriber ID.
nameSubscriber name.
Email address of subscriber.
Webhook URI of subscriber.