Backends

Download schema

The Load Balancer backend object. It represents a set of backend servers that the frontend forwards requests to using the specified configuration (port, protocol, proxy protocol etc). You can create multiple backends for each of your Load Balancers. Use the backends endpoint to create backends, list, manage and update them and their healthchecks / backend servers, and delete them as required

Get a backend of a given Load Balancer

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/backends/{backend_id}

Get the full details of a given backend, specified by its backend ID. The response contains the backend's full configuration parameters including protocol, port and forwarding algorithm.

Get a backend of 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

backend_id

string · required

Backend ID.

Get a backend of a given Load Balancer › Responses

200

scaleway.lb.v1.Backend

id

string

Backend ID.

name

string

Name of the backend.

forward_protocol

string · enum

Protocol used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32

Port used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum

Load balancing algorithm to use when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum

Defines whether sticky sessions (binding a particular session to a particular backend server) are activated and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.

Enum values:

none

table

Default: none

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

object

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

pool

string[]

List of IP addresses of backend servers attached to this backend.

object

Load Balancer the backend is attached to.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

Default: 300000

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

Default: 5000

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

Default: 900000

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

created_at

string · date-time

Date at which the backend was created. (RFC 3339 format)

updated_at

string · date-time

Date at which the backend was updated. (RFC 3339 format)

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

GET/lb/v1/zones/{zone}/backends/{backend_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}"

Example Responses

{
  "id": "id",
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "health_check": {
    "port": 0,
    "check_delay": 3000,
    "check_timeout": 1000,
    "check_max_retries": 0,
    "tcp_config": {},
    "mysql_config": {
      "user": "user"
    },
    "pgsql_config": {
      "user": "user"
    },
    "ldap_config": {},
    "redis_config": {},
    "http_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header"
    },
    "https_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header",
      "sni": "sni"
    },
    "check_send_proxy": true,
    "transient_check_delay": "2.5s"
  },
  "pool": [
    "string"
  ],
  "lb": {
    "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"
  },
  "send_proxy_v2": true,
  "timeout_server": 300000,
  "timeout_connect": 5000,
  "timeout_tunnel": 900000,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

application/json

Update a backend of a given Load Balancer

PUT

https://api.scaleway.com

/lb/v1/zones/{zone}/backends/{backend_id}

Update a backend of a given Load Balancer, specified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters.

Update a backend of 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

backend_id

string · required

Backend ID.

Update a backend of a given Load Balancer › Request Body

name

string · required

Backend name.

forward_protocol

string · enum · required

Protocol to be used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32 · required

Port to be used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum · required

Load balancing algorithm to be used when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum · required

Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.

Enum values:

none

table

Default: none

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

Update a backend of a given Load Balancer › Responses

200

scaleway.lb.v1.Backend

id

string

Backend ID.

name

string

Name of the backend.

forward_protocol

string · enum

Protocol used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32

Port used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum

Load balancing algorithm to use when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum

Enum values:

none

table

Default: none

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

object

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

pool

string[]

List of IP addresses of backend servers attached to this backend.

object

Load Balancer the backend is attached to.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

Default: 300000

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

Default: 5000

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

Default: 900000

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

created_at

string · date-time

Date at which the backend was created. (RFC 3339 format)

updated_at

string · date-time

Date at which the backend was updated. (RFC 3339 format)

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

PUT/lb/v1/zones/{zone}/backends/{backend_id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "forward_port": 42,
    "forward_port_algorithm": "roundrobin",
    "forward_protocol": "tcp",
    "name": "string",
    "send_proxy_v2": false,
    "sticky_sessions": "none",
    "sticky_sessions_cookie_name": "string"
  }' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}"

Example Request Body

{
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "send_proxy_v2": true,
  "timeout_server": 0,
  "timeout_connect": 0,
  "timeout_tunnel": 0,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "health_check": {
    "port": 0,
    "check_delay": 3000,
    "check_timeout": 1000,
    "check_max_retries": 0,
    "tcp_config": {},
    "mysql_config": {
      "user": "user"
    },
    "pgsql_config": {
      "user": "user"
    },
    "ldap_config": {},
    "redis_config": {},
    "http_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header"
    },
    "https_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header",
      "sni": "sni"
    },
    "check_send_proxy": true,
    "transient_check_delay": "2.5s"
  },
  "pool": [
    "string"
  ],
  "lb": {
    "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"
  },
  "send_proxy_v2": true,
  "timeout_server": 300000,
  "timeout_connect": 5000,
  "timeout_tunnel": 900000,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

application/json

Delete a backend of a given Load Balancer

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/backends/{backend_id}

Delete a backend of a given Load Balancer, specified by its backend ID. This action is irreversible and cannot be undone.

Delete a backend of 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

backend_id

string · required

ID of the backend to delete.

Delete a backend of a given Load Balancer › Responses

No data returned

Update a health check for a given backend

PUT

https://api.scaleway.com

/lb/v1/zones/{zone}/backends/{backend_id}/healthcheck

Update the configuration of the health check performed by a given backend to verify the health of its backend servers, identified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters.

Update a health check for a given backend › 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

backend_id

string · required

Backend ID.

Update a health check for a given backend › Request Body

port

integer · int32 · required

Port to use for the backend server health check.

check_delay

number · required

Time to wait between two consecutive health checks. (in milliseconds)

check_timeout

number · required

Maximum time a backend server has to reply to the health check. (in milliseconds)

check_max_retries

integer · int32 · required

Number of consecutive unsuccessful health checks after which the server will be considered dead.

check_send_proxy

boolean

Defines whether proxy protocol should be activated for the health check.

tcp_config

object

Object to configure a basic TCP health check.

object

Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.

object

Object to configure a PostgreSQL health check.

ldap_config

object

Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.

redis_config

object

Object to configure a Redis health check. The response is analyzed to find the +PONG response message.

object

Object to configure an HTTP health check.

object

Object to configure an HTTPS health check.

transient_check_delay

string

Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN). (in seconds)

Update a health check for a given backend › Responses

200

scaleway.lb.v1.HealthCheck

port

integer · int32

Port to use for the backend server health check.

check_delay

number

Time to wait between two consecutive health checks. (in milliseconds)

Default: 3000

check_timeout

number

Maximum time a backend server has to reply to the health check. (in milliseconds)

Default: 1000

check_max_retries

integer · int32

Number of consecutive unsuccessful health checks after which the server will be considered dead.

tcp_config

object

Object to configure a basic TCP health check.

object

Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.

object

Object to configure a PostgreSQL health check.

ldap_config

object

Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.

redis_config

object

Object to configure a Redis health check. The response is analyzed to find the +PONG response message.

object

Object to configure an HTTP health check.

object

Object to configure an HTTPS health check.

check_send_proxy

boolean

Defines whether proxy protocol should be activated for the health check.

transient_check_delay

string

Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN). (in seconds)

Default: 0.5s

PUT/lb/v1/zones/{zone}/backends/{backend_id}/healthcheck

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "check_delay": 42,
    "check_max_retries": 42,
    "check_send_proxy": false,
    "check_timeout": 42,
    "port": 42
  }' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}/healthcheck"

Example Request Body

{
  "port": 0,
  "check_delay": 0,
  "check_timeout": 0,
  "check_max_retries": 0,
  "check_send_proxy": true,
  "tcp_config": {},
  "mysql_config": {
    "user": "user"
  },
  "pgsql_config": {
    "user": "user"
  },
  "ldap_config": {},
  "redis_config": {},
  "http_config": {
    "uri": "uri",
    "method": "method",
    "code": 0,
    "host_header": "host_header"
  },
  "https_config": {
    "uri": "uri",
    "method": "method",
    "code": 0,
    "host_header": "host_header",
    "sni": "sni"
  },
  "transient_check_delay": "2.5s"
}

json

Example Responses

{
  "port": 0,
  "check_delay": 3000,
  "check_timeout": 1000,
  "check_max_retries": 0,
  "tcp_config": {},
  "mysql_config": {
    "user": "user"
  },
  "pgsql_config": {
    "user": "user"
  },
  "ldap_config": {},
  "redis_config": {},
  "http_config": {
    "uri": "uri",
    "method": "method",
    "code": 0,
    "host_header": "host_header"
  },
  "https_config": {
    "uri": "uri",
    "method": "method",
    "code": 0,
    "host_header": "host_header",
    "sni": "sni"
  },
  "check_send_proxy": true,
  "transient_check_delay": "2.5s"
}

json

application/json

Define all backend servers for a given backend

PUT

https://api.scaleway.com

/lb/v1/zones/{zone}/backends/{backend_id}/servers

For a given backend specified by its backend ID, define the set of backend servers (identified by their IP addresses) that it should forward traffic to. Any existing backend servers configured for this backend will be removed.

Define all backend servers for a given backend › 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

backend_id

string · required

Backend ID.

Define all backend servers for a given backend › Request Body

server_ip

string[] · required

List of IP addresses for backend servers. Any other existing backend servers will be removed.

Define all backend servers for a given backend › Responses

200

scaleway.lb.v1.Backend

id

string

Backend ID.

name

string

Name of the backend.

forward_protocol

string · enum

Protocol used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32

Port used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum

Load balancing algorithm to use when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum

Enum values:

none

table

Default: none

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

object

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

pool

string[]

List of IP addresses of backend servers attached to this backend.

object

Load Balancer the backend is attached to.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

Default: 300000

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

Default: 5000

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

Default: 900000

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

created_at

string · date-time

Date at which the backend was created. (RFC 3339 format)

updated_at

string · date-time

Date at which the backend was updated. (RFC 3339 format)

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

PUT/lb/v1/zones/{zone}/backends/{backend_id}/servers

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"server_ip":["string"]}' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}/servers"

Example Request Body

{
  "server_ip": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "health_check": {
    "port": 0,
    "check_delay": 3000,
    "check_timeout": 1000,
    "check_max_retries": 0,
    "tcp_config": {},
    "mysql_config": {
      "user": "user"
    },
    "pgsql_config": {
      "user": "user"
    },
    "ldap_config": {},
    "redis_config": {},
    "http_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header"
    },
    "https_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header",
      "sni": "sni"
    },
    "check_send_proxy": true,
    "transient_check_delay": "2.5s"
  },
  "pool": [
    "string"
  ],
  "lb": {
    "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"
  },
  "send_proxy_v2": true,
  "timeout_server": 300000,
  "timeout_connect": 5000,
  "timeout_tunnel": 900000,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

application/json

Add a set of backend servers to a given backend

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/backends/{backend_id}/servers

For a given backend specified by its backend ID, add a set of backend servers (identified by their IP addresses) it should forward traffic to. These will be appended to any existing set of backend servers for this backend.

Add a set of backend servers to a given backend › 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

backend_id

string · required

Backend ID.

Add a set of backend servers to a given backend › Request Body

server_ip

string[] · required

List of IP addresses to add to backend servers.

Add a set of backend servers to a given backend › Responses

200

scaleway.lb.v1.Backend

id

string

Backend ID.

name

string

Name of the backend.

forward_protocol

string · enum

Protocol used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32

Port used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum

Load balancing algorithm to use when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum

Enum values:

none

table

Default: none

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

object

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

pool

string[]

List of IP addresses of backend servers attached to this backend.

object

Load Balancer the backend is attached to.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

Default: 300000

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

Default: 5000

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

Default: 900000

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

created_at

string · date-time

Date at which the backend was created. (RFC 3339 format)

updated_at

string · date-time

Date at which the backend was updated. (RFC 3339 format)

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

POST/lb/v1/zones/{zone}/backends/{backend_id}/servers

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"server_ip":["string"]}' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}/servers"

Example Request Body

{
  "server_ip": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "health_check": {
    "port": 0,
    "check_delay": 3000,
    "check_timeout": 1000,
    "check_max_retries": 0,
    "tcp_config": {},
    "mysql_config": {
      "user": "user"
    },
    "pgsql_config": {
      "user": "user"
    },
    "ldap_config": {},
    "redis_config": {},
    "http_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header"
    },
    "https_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header",
      "sni": "sni"
    },
    "check_send_proxy": true,
    "transient_check_delay": "2.5s"
  },
  "pool": [
    "string"
  ],
  "lb": {
    "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"
  },
  "send_proxy_v2": true,
  "timeout_server": 300000,
  "timeout_connect": 5000,
  "timeout_tunnel": 900000,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

application/json

Remove a set of servers for a given backend

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/backends/{backend_id}/servers

For a given backend specified by its backend ID, remove the specified backend servers (identified by their IP addresses) so that it no longer forwards traffic to them.

Remove a set of servers for a given backend › 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

backend_id

string · required

Backend ID.

Remove a set of servers for a given backend › Request Body

server_ip

string[] · required

List of IP addresses to remove from backend servers.

Remove a set of servers for a given backend › Responses

200

scaleway.lb.v1.Backend

id

string

Backend ID.

name

string

Name of the backend.

forward_protocol

string · enum

Protocol used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32

Port used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum

Load balancing algorithm to use when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum

Enum values:

none

table

Default: none

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

object

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

pool

string[]

List of IP addresses of backend servers attached to this backend.

object

Load Balancer the backend is attached to.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

Default: 300000

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

Default: 5000

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

Default: 900000

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

created_at

string · date-time

Date at which the backend was created. (RFC 3339 format)

updated_at

string · date-time

Date at which the backend was updated. (RFC 3339 format)

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

DELETE/lb/v1/zones/{zone}/backends/{backend_id}/servers

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"server_ip":["string"]}' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}/servers"

Example Request Body

{
  "server_ip": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "health_check": {
    "port": 0,
    "check_delay": 3000,
    "check_timeout": 1000,
    "check_max_retries": 0,
    "tcp_config": {},
    "mysql_config": {
      "user": "user"
    },
    "pgsql_config": {
      "user": "user"
    },
    "ldap_config": {},
    "redis_config": {},
    "http_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header"
    },
    "https_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header",
      "sni": "sni"
    },
    "check_send_proxy": true,
    "transient_check_delay": "2.5s"
  },
  "pool": [
    "string"
  ],
  "lb": {
    "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"
  },
  "send_proxy_v2": true,
  "timeout_server": 300000,
  "timeout_connect": 5000,
  "timeout_tunnel": 900000,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

application/json

List backend server statistics

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/backend-stats

List information about your backend servers, including their state and the result of their last health check.

List backend server statistics › 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.

List backend server statistics › query Parameters

page

integer · int32

The page number to return, from the paginated results.

page_size

integer · uint32

Number of items to return.

backend_id

string

ID of the backend.

List backend server statistics › Responses

200

scaleway.lb.v1.ListBackendStatsResponse

scaleway.lb.v1.BackendServerStats[]

List of objects containing backend server statistics.

total_count

integer · uint32

The total number of objects.

List the backends of a given Load Balancer

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/backends

List all the backends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each backend. The response is an array of backend objects, containing full details of each one including their configuration parameters such as protocol, port and forwarding algorithm.

List the backends of 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.

List the backends of a given Load Balancer › query Parameters

name

string

Name of the backend to filter for.

order_by

string · enum

Sort order of backends 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

Number of backends to return.

List the backends of a given Load Balancer › Responses

200

scaleway.lb.v1.ListBackendsResponse

scaleway.lb.v1.Backend[]

List of backend objects of a given Load Balancer.

total_count

integer · uint32

Total count of backend objects, without pagination.

GET/lb/v1/zones/{zone}/lbs/{lb_id}/backends

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

Example Responses

{
  "backends": [
    {
      "id": "id",
      "name": "name",
      "forward_protocol": "tcp",
      "forward_port": 0,
      "forward_port_algorithm": "roundrobin",
      "sticky_sessions": "none",
      "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
      "health_check": {
        "port": 0,
        "check_delay": 3000,
        "check_timeout": 1000,
        "check_max_retries": 0,
        "tcp_config": {},
        "mysql_config": {
          "user": "user"
        },
        "pgsql_config": {
          "user": "user"
        },
        "ldap_config": {},
        "redis_config": {},
        "http_config": {
          "uri": "uri",
          "method": "method",
          "code": 0,
          "host_header": "host_header"
        },
        "https_config": {
          "uri": "uri",
          "method": "method",
          "code": 0,
          "host_header": "host_header",
          "sni": "sni"
        },
        "check_send_proxy": true,
        "transient_check_delay": "2.5s"
      },
      "pool": [
        "string"
      ],
      "lb": {
        "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"
      },
      "send_proxy_v2": true,
      "timeout_server": 300000,
      "timeout_connect": 5000,
      "timeout_tunnel": 900000,
      "on_marked_down_action": "on_marked_down_action_none",
      "proxy_protocol": "proxy_protocol_unknown",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "failover_host": "failover_host",
      "ssl_bridging": true,
      "ignore_ssl_server_verify": true,
      "redispatch_attempt_count": 0,
      "max_retries": 0,
      "max_connections": 0,
      "timeout_queue": "2.5s"
    }
  ],
  "total_count": 0
}

json

application/json

Create a backend for a given Load Balancer

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/backends

Create a new backend for a given Load Balancer, specifying its full configuration including protocol, port and forwarding algorithm.

Create a backend 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.

Create a backend for a given Load Balancer › Request Body

name

string · required

Name for the backend.

forward_protocol

string · enum · required

Protocol to be used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32 · required

Port to be used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum · required

Load balancing algorithm to be used when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum · required

Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie TO stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.

Enum values:

none

table

Default: none

object · required

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

server_ip

string[] · required

List of backend server IP addresses (IPv4 or IPv6) the backend should forward traffic to.

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

Create a backend for a given Load Balancer › Responses

200

scaleway.lb.v1.Backend

id

string

Backend ID.

name

string

Name of the backend.

forward_protocol

string · enum

Protocol used by the backend when forwarding traffic to backend servers.

Enum values:

tcp

http

Default: tcp

forward_port

integer · int32

Port used by the backend when forwarding traffic to backend servers.

forward_port_algorithm

string · enum

Load balancing algorithm to use when determining which backend server to forward new traffic to.

Enum values:

roundrobin

leastconn

first

Default: roundrobin

sticky_sessions

string · enum

Enum values:

none

table

Default: none

sticky_sessions_cookie_name

string

Cookie name for cookie-based sticky sessions.

object

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

pool

string[]

List of IP addresses of backend servers attached to this backend.

object

Load Balancer the backend is attached to.

timeout_server

number

Maximum allowed time for a backend server to process a request. (in milliseconds)

Default: 300000

timeout_connect

number

Maximum allowed time for establishing a connection to a backend server. (in milliseconds)

Default: 5000

timeout_tunnel

number

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)

Default: 900000

on_marked_down_action

string · enum

Action to take when a backend server is marked as down.

Enum values:

on_marked_down_action_none

shutdown_sessions

Default: on_marked_down_action_none

proxy_protocol

string · enum

Enum values:

proxy_protocol_unknown

proxy_protocol_none

proxy_protocol_v1

proxy_protocol_v2

proxy_protocol_v2_ssl

proxy_protocol_v2_ssl_cn

Default: proxy_protocol_unknown

created_at

string · date-time

Date at which the backend was created. (RFC 3339 format)

updated_at

string · date-time

Date at which the backend was updated. (RFC 3339 format)

failover_host

string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

ssl_bridging

boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

ignore_ssl_server_verify

boolean

Defines whether the server certificate verification should be ignored.

redispatch_attempt_count

integer · int32

Whether to use another backend server on each attempt.

max_retries

integer · int32

Number of retries when a backend server connection failed.

max_connections

integer · int32

Maximum number of connections allowed per backend server.

timeout_queue

string

Maximum time for a request to be left pending in queue when max_connections is reached. (in seconds)

POST/lb/v1/zones/{zone}/lbs/{lb_id}/backends

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "forward_port": 42,
    "forward_port_algorithm": "roundrobin",
    "forward_protocol": "tcp",
    "health_check": {
        "check_delay": 3000,
        "check_max_retries": 42,
        "check_send_proxy": false,
        "check_timeout": 1000,
        "http_config": {
            "code": 42,
            "host_header": "string",
            "method": "string",
            "uri": "string"
        },
        "https_config": {
            "code": 42,
            "host_header": "string",
            "method": "string",
            "sni": "string",
            "uri": "string"
        },
        "ldap_config": {},
        "mysql_config": {
            "user": "string"
        },
        "pgsql_config": {
            "user": "string"
        },
        "port": 42,
        "redis_config": {},
        "tcp_config": {},
        "transient_check_delay": "2.5s"
    },
    "name": "string",
    "send_proxy_v2": false,
    "server_ip": [
        "string"
    ],
    "sticky_sessions": "none",
    "sticky_sessions_cookie_name": "string"
  }' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/lbs/{lb_id}/backends"

Example Request Body

{
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "health_check": {
    "port": 0,
    "check_delay": 3000,
    "check_timeout": 1000,
    "check_max_retries": 0,
    "tcp_config": {},
    "mysql_config": {
      "user": "user"
    },
    "pgsql_config": {
      "user": "user"
    },
    "ldap_config": {},
    "redis_config": {},
    "http_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header"
    },
    "https_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header",
      "sni": "sni"
    },
    "check_send_proxy": true,
    "transient_check_delay": "2.5s"
  },
  "server_ip": [
    "string"
  ],
  "send_proxy_v2": true,
  "timeout_server": 0,
  "timeout_connect": 0,
  "timeout_tunnel": 0,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "forward_protocol": "tcp",
  "forward_port": 0,
  "forward_port_algorithm": "roundrobin",
  "sticky_sessions": "none",
  "sticky_sessions_cookie_name": "sticky_sessions_cookie_name",
  "health_check": {
    "port": 0,
    "check_delay": 3000,
    "check_timeout": 1000,
    "check_max_retries": 0,
    "tcp_config": {},
    "mysql_config": {
      "user": "user"
    },
    "pgsql_config": {
      "user": "user"
    },
    "ldap_config": {},
    "redis_config": {},
    "http_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header"
    },
    "https_config": {
      "uri": "uri",
      "method": "method",
      "code": 0,
      "host_header": "host_header",
      "sni": "sni"
    },
    "check_send_proxy": true,
    "transient_check_delay": "2.5s"
  },
  "pool": [
    "string"
  ],
  "lb": {
    "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"
  },
  "send_proxy_v2": true,
  "timeout_server": 300000,
  "timeout_connect": 5000,
  "timeout_tunnel": 900000,
  "on_marked_down_action": "on_marked_down_action_none",
  "proxy_protocol": "proxy_protocol_unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "failover_host": "failover_host",
  "ssl_bridging": true,
  "ignore_ssl_server_verify": true,
  "redispatch_attempt_count": 0,
  "max_retries": 0,
  "max_connections": 0,
  "timeout_queue": "2.5s"
}

json

application/json

Frontends Route