Alert Subscribers

Download schema

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.

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/lb/{lb_id}/subscribe

Subscribe an existing subscriber to alerts for a given Load Balancer.

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID.

subscriber_id

string · required

Subscriber ID.

200

scaleway.lb.v1.Lb

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

scaleway.lb.v1.Lb.Status · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

scaleway.lb.v1.Instance[]

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.

scaleway.lb.v1.Ip[]

List of IP addresses attached to the Load Balancer.

tags

string[]

Load Balancer tags.

frontend_count

integer · int32

Number of frontends the Load Balancer has.

backend_count

integer · int32

Number of backends the Load Balancer has.

type

string

Load Balancer offer type.

scaleway.lb.v1.Subscriber

Subscriber information.

ssl_compatibility_level

scaleway.lb.v1.SSLCompatibilityLevel · enum

Determines the minimal SSL version which needs to be supported on client side.

Enum values:

ssl_compatibility_level_unknown

ssl_compatibility_level_intermediate

ssl_compatibility_level_modern

ssl_compatibility_level_old

Default: ssl_compatibility_level_unknown

created_at

string | null · date-time

Date on which the Load Balancer was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the Load Balancer was last updated. (RFC 3339 format)

private_network_count

integer · int32

Number of Private Networks attached to the Load Balancer.

route_count

integer · int32

Number of routes configured on the Load Balancer.

zone

string

The zone the Load Balancer is in.

POST/lb/v1/zones/{zone}/lb/{lb_id}/subscribe

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subscriber_id":"string"}' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/lb/{lb_id}/subscribe"

Example Request Body

{
  "subscriber_id": "subscriber_id"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "status": "unknown",
  "instances": [
    {
      "id": "id",
      "status": "unknown",
      "ip_address": "ip_address",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "region": "region",
      "zone": "zone"
    }
  ],
  "organization_id": "organization_id",
  "project_id": "project_id",
  "ip": [
    {
      "id": "id",
      "ip_address": "ip_address",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "lb_id": "lb_id",
      "reverse": "reverse",
      "tags": [
        "string"
      ],
      "region": "region",
      "zone": "zone"
    }
  ],
  "tags": [
    "string"
  ],
  "frontend_count": 0,
  "backend_count": 0,
  "type": "type",
  "subscriber": {
    "id": "id",
    "name": "name",
    "email_config": {
      "email": "email"
    },
    "webhook_config": {
      "uri": "uri"
    }
  },
  "ssl_compatibility_level": "ssl_compatibility_level_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_count": 0,
  "route_count": 0,
  "region": "region",
  "zone": "zone"
}

json

application/json

Unsubscribe a subscriber from alerts for a given Load Balancer

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/lb/{lb_id}/unsubscribe

Unsubscribe a subscriber from alerts for a given Load Balancer. The subscriber is not deleted, and can be resubscribed in the future if necessary.

Unsubscribe a subscriber from alerts for a given Load Balancer › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID.

Unsubscribe a subscriber from alerts for a given Load Balancer › Responses

200

scaleway.lb.v1.Lb

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

scaleway.lb.v1.Lb.Status · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

scaleway.lb.v1.Instance[]

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.

scaleway.lb.v1.Ip[]

List of IP addresses attached to the Load Balancer.

tags

string[]

Load Balancer tags.

frontend_count

integer · int32

Number of frontends the Load Balancer has.

backend_count

integer · int32

Number of backends the Load Balancer has.

type

string

Load Balancer offer type.

scaleway.lb.v1.Subscriber

Subscriber information.

ssl_compatibility_level

scaleway.lb.v1.SSLCompatibilityLevel · enum

Determines the minimal SSL version which needs to be supported on client side.

Enum values:

ssl_compatibility_level_unknown

ssl_compatibility_level_intermediate

ssl_compatibility_level_modern

ssl_compatibility_level_old

Default: ssl_compatibility_level_unknown

created_at

string | null · date-time

Date on which the Load Balancer was created. (RFC 3339 format)

updated_at

string | null · date-time

Date on which the Load Balancer was last updated. (RFC 3339 format)

private_network_count

integer · int32

Number of Private Networks attached to the Load Balancer.

route_count

integer · int32

Number of routes configured on the Load Balancer.

zone

string

The zone the Load Balancer is in.

DELETE/lb/v1/zones/{zone}/lb/{lb_id}/unsubscribe

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/zones/{zone}/lb/{lb_id}/unsubscribe"

Example Responses

{
  "id": "id",
  "name": "name",
  "description": "description",
  "status": "unknown",
  "instances": [
    {
      "id": "id",
      "status": "unknown",
      "ip_address": "ip_address",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "region": "region",
      "zone": "zone"
    }
  ],
  "organization_id": "organization_id",
  "project_id": "project_id",
  "ip": [
    {
      "id": "id",
      "ip_address": "ip_address",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "lb_id": "lb_id",
      "reverse": "reverse",
      "tags": [
        "string"
      ],
      "region": "region",
      "zone": "zone"
    }
  ],
  "tags": [
    "string"
  ],
  "frontend_count": 0,
  "backend_count": 0,
  "type": "type",
  "subscriber": {
    "id": "id",
    "name": "name",
    "email_config": {
      "email": "email"
    },
    "webhook_config": {
      "uri": "uri"
    }
  },
  "ssl_compatibility_level": "ssl_compatibility_level_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_count": 0,
  "route_count": 0,
  "region": "region",
  "zone": "zone"
}

json

application/json

Delete a subscriber

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/lb/subscription/{subscriber_id}

Delete an existing subscriber, specified by its subscriber ID. Deleting a subscriber is permanent, and cannot be undone.

Delete a subscriber › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

subscriber_id

string · required

Subscriber ID.

Delete a subscriber › Responses

No data returned

List all subscribers

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/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.

List all subscribers › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

List all subscribers › query Parameters

order_by

scaleway.lb.v1.ListSubscriberRequest.OrderBy · enum

Sort order of subscribers in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

page

integer · int32

The page number to return, from the paginated results.

page_size

integer · uint32

The number of items to return.

name

string

Subscriber name to search for.

organization_id

string

Filter subscribers by Organization ID.

project_id

string

Filter subscribers by Project ID.

List all subscribers › Responses

200

scaleway.lb.v1.ListSubscriberResponse

scaleway.lb.v1.Subscriber[]

List of subscriber objects.

total_count

integer · uint32

The total number of objects.

Create a subscriber

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/subscribers

Create a new subscriber, either with an email configuration or a webhook configuration, for a specified Scaleway Project.

Create a subscriber › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

Create a subscriber › Request Body

name

string · required

Subscriber name.

Email address configuration.

WebHook URI configuration.

project_id

string | null

Project ID to create the subscriber in.

Create a subscriber › Responses

200

scaleway.lb.v1.Subscriber

id

string

Subscriber ID.

name

string

Subscriber name.

Email address of subscriber.

Webhook URI of subscriber.

Get a subscriber

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/subscribers/{subscriber_id}

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.

Get a subscriber › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

subscriber_id

string · required

Subscriber ID.

Get a subscriber › Responses

200

scaleway.lb.v1.Subscriber

id

string

Subscriber ID.

name

string

Subscriber name.

Email address of subscriber.

Webhook URI of subscriber.

Update a subscriber

PUT

https://api.scaleway.com

/lb/v1/zones/{zone}/subscribers/{subscriber_id}

Update the parameters of a given subscriber (e.g. name, webhook configuration, email configuration), specified by its subscriber ID.

Update a subscriber › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

subscriber_id

string · required

Subscriber ID.

Update a subscriber › Request Body

name

string · required

Subscriber name.

Email address configuration.

Webhook URI configuration.

Update a subscriber › Responses

200

scaleway.lb.v1.Subscriber

id

string

Subscriber ID.

name

string

Subscriber name.

Email address of subscriber.

Webhook URI of subscriber.

Load Balancer Types Private Networks

Alert Subscribers

Subscribe a subscriber to alerts for a given Load Balancer

Subscribe a subscriber to alerts for a given Load Balancer › path Parameters

Subscribe a subscriber to alerts for a given Load Balancer › Request Body

Subscribe a subscriber to alerts for a given Load Balancer › Responses

Unsubscribe a subscriber from alerts for a given Load Balancer

Unsubscribe a subscriber from alerts for a given Load Balancer › path Parameters

Unsubscribe a subscriber from alerts for a given Load Balancer › Responses

Delete a subscriber

Delete a subscriber › path Parameters

Delete a subscriber › Responses

List all subscribers

List all subscribers › path Parameters

List all subscribers › query Parameters

List all subscribers › Responses

Create a subscriber

Create a subscriber › path Parameters

Create a subscriber › Request Body

Create a subscriber › Responses

Get a subscriber

Get a subscriber › path Parameters

Get a subscriber › Responses

Update a subscriber

Update a subscriber › path Parameters

Update a subscriber › Request Body

Update a subscriber › Responses