Other endpoints

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/regions/{region}/backends/{backend_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/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"
}

application/json

Update a backend in a given load balancer

PUT

https://api.scaleway.com

/lb/v1/regions/{region}/backends/{backend_id}

Update a backend in a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

backend_id

string · required

Backend ID.

Update a backend in 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 in a given load balancer › Responses

200

scaleway.lb.v1.HealthCheck

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/regions/{region}/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/regions/{region}/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"
}

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"
}

application/json

Delete a backend in a given load balancer

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/backends/{backend_id}

Delete a backend in a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

backend_id

string · required

ID of the backend to delete.

Delete a backend in a given load balancer › Responses

No data returned

DELETE/lb/v1/regions/{region}/backends/{backend_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/backends/{backend_id}"

Example Responses

No example specified for this content type

Update an health check for a given backend

PUT

https://api.scaleway.com

/lb/v1/regions/{region}/backends/{backend_id}/healthcheck

Update an health check for a given backend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

backend_id

string · required

Backend ID.

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

200

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/regions/{region}/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/regions/{region}/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"
}

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"
}

application/json

Define all servers in a given backend

PUT

https://api.scaleway.com

/lb/v1/regions/{region}/backends/{backend_id}/servers

Define all servers in a given backend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

backend_id

string · required

Backend ID.

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

200

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/regions/{region}/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/regions/{region}/backends/{backend_id}/servers"

Example Request Body

{
  "server_ip": [
    "string"
  ]
}

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"
}

application/json

Add a set of servers in a given backend

POST

https://api.scaleway.com

/lb/v1/regions/{region}/backends/{backend_id}/servers

Add a set of servers in a given backend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

backend_id

string · required

Backend ID.

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

server_ip

string[] · required

List of IP addresses to add to backend servers.

Add a set of servers in a given backend › Responses

200

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/regions/{region}/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/regions/{region}/backends/{backend_id}/servers"

Example Request Body

{
  "server_ip": [
    "string"
  ]
}

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"
}

application/json

Remove a set of servers for a given backend

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/backends/{backend_id}/servers

Remove a set of servers for a given backend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

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.Certificate

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/regions/{region}/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/regions/{region}/backends/{backend_id}/servers"

Example Request Body

{
  "server_ip": [
    "string"
  ]
}

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"
}

application/json

Get a TLS certificate

GET

https://api.scaleway.com

/lb/v1/regions/{region}/certificates/{certificate_id}

Get a TLS certificate › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

certificate_id

string · required

Certificate ID.

Get a TLS certificate › Responses

200

type

string · enum

Certificate type (Let's Encrypt or custom).

Enum values:

letsencryt

custom

letsencrypt

Default: letsencryt

id

string

Certificate ID.

common_name

string

Main domain name of certificate.

subject_alternative_name

string[]

Alternative domain names.

fingerprint

string

Identifier (SHA-1) of the certificate.

not_valid_before

string · date-time

Lower validity bound. (RFC 3339 format)

not_valid_after

string · date-time

Upper validity bound. (RFC 3339 format)

status

string · enum

Certificate status.

Enum values:

pending

ready

error

Default: pending

object

Load Balancer object the certificate is attached to.

name

string

Certificate name.

created_at

string · date-time

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

updated_at

string · date-time

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

status_details

string

Additional information about the certificate status (useful in case of certificate generation failure, for example).

GET/lb/v1/regions/{region}/certificates/{certificate_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/certificates/{certificate_id}"

Example Responses

{
  "type": "letsencryt",
  "id": "id",
  "common_name": "common_name",
  "subject_alternative_name": [
    "string"
  ],
  "fingerprint": "fingerprint",
  "not_valid_before": "2022-03-22T12:34:56.123456Z",
  "not_valid_after": "2022-03-22T12:34:56.123456Z",
  "status": "pending",
  "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"
  },
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status_details": "status_details"
}

application/json

Update a TLS certificate

PUT

https://api.scaleway.com

/lb/v1/regions/{region}/certificates/{certificate_id}

Update a TLS certificate › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

certificate_id

string · required

Certificate ID.

Update a TLS certificate › Request Body

name

string · required

Certificate name.

Update a TLS certificate › Responses

200

scaleway.lb.v1.Certificate

type

string · enum

Certificate type (Let's Encrypt or custom).

Enum values:

letsencryt

custom

letsencrypt

Default: letsencryt

id

string

Certificate ID.

common_name

string

Main domain name of certificate.

subject_alternative_name

string[]

Alternative domain names.

fingerprint

string

Identifier (SHA-1) of the certificate.

not_valid_before

string · date-time

Lower validity bound. (RFC 3339 format)

not_valid_after

string · date-time

Upper validity bound. (RFC 3339 format)

status

string · enum

Certificate status.

Enum values:

pending

ready

error

Default: pending

object

Load Balancer object the certificate is attached to.

name

string

Certificate name.

created_at

string · date-time

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

updated_at

string · date-time

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

status_details

string

Additional information about the certificate status (useful in case of certificate generation failure, for example).

PUT/lb/v1/regions/{region}/certificates/{certificate_id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/lb/v1/regions/{region}/certificates/{certificate_id}"

Example Request Body

{
  "name": "name"
}

Example Responses

{
  "type": "letsencryt",
  "id": "id",
  "common_name": "common_name",
  "subject_alternative_name": [
    "string"
  ],
  "fingerprint": "fingerprint",
  "not_valid_before": "2022-03-22T12:34:56.123456Z",
  "not_valid_after": "2022-03-22T12:34:56.123456Z",
  "status": "pending",
  "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"
  },
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status_details": "status_details"
}

application/json

Delete a TLS certificate

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/certificates/{certificate_id}

Delete a TLS certificate › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

certificate_id

string · required

Certificate ID.

Delete a TLS certificate › Responses

No data returned

DELETE/lb/v1/regions/{region}/certificates/{certificate_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/certificates/{certificate_id}"

Example Responses

No example specified for this content type

Get a frontend

GET

https://api.scaleway.com

/lb/v1/regions/{region}/frontends/{frontend_id}

Get a frontend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

frontend_id

string · required

Frontend ID.

Get a frontend › Responses

200

scaleway.lb.v1.Frontend

id

string

Frontend ID.

name

string

Name of the frontend.

inbound_port

integer · int32

Port the frontend listens on.

object

Backend object the frontend is attached to.

object

Load Balancer object the frontend is attached to.

timeout_client

number

Maximum allowed inactivity time on the client side. (in milliseconds)

Default: 300000

certificate_ids

string[]

List of SSL/TLS certificate IDs to bind to the frontend.

created_at

string · date-time

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

updated_at

string · date-time

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

enable_http3

boolean

Defines whether to enable HTTP/3 protocol on the frontend.

connection_rate_limit

integer · uint32

Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.

enable_access_logs

boolean

Defines whether to enable access logs on the frontend.

GET/lb/v1/regions/{region}/frontends/{frontend_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/frontends/{frontend_id}"

Example Responses

{
  "id": "id",
  "name": "name",
  "inbound_port": 0,
  "backend": {
    "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"
  },
  "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"
  },
  "timeout_client": 300000,
  "certificate": {
    "type": "letsencryt",
    "id": "id",
    "common_name": "common_name",
    "subject_alternative_name": [
      "string"
    ],
    "fingerprint": "fingerprint",
    "not_valid_before": "2022-03-22T12:34:56.123456Z",
    "not_valid_after": "2022-03-22T12:34:56.123456Z",
    "status": "pending",
    "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"
    },
    "name": "name",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "status_details": "status_details"
  },
  "certificate_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "enable_http3": true,
  "connection_rate_limit": 0,
  "enable_access_logs": true
}

application/json

Update a frontend

PUT

https://api.scaleway.com

/lb/v1/regions/{region}/frontends/{frontend_id}

Update a frontend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

frontend_id

string · required

Frontend ID.

Update a frontend › Request Body

name

string · required

Frontend name.

inbound_port

integer · int32 · required

Port the frontend should listen on.

backend_id

string · required

Backend ID (ID of the backend the frontend should pass traffic to).

timeout_client

number

Maximum allowed inactivity time on the client side. (in milliseconds)

certificate_ids

string[]

List of SSL/TLS certificate IDs to bind to the frontend.

enable_http3

boolean

Defines whether to enable HTTP/3 protocol on the frontend.

connection_rate_limit

integer · uint32

Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.

enable_access_logs

boolean

Defines whether to enable access logs on the frontend.

Update a frontend › Responses

200

scaleway.lb.v1.Frontend

id

string

Frontend ID.

name

string

Name of the frontend.

inbound_port

integer · int32

Port the frontend listens on.

object

Backend object the frontend is attached to.

object

Load Balancer object the frontend is attached to.

timeout_client

number

Maximum allowed inactivity time on the client side. (in milliseconds)

Default: 300000

certificate_ids

string[]

List of SSL/TLS certificate IDs to bind to the frontend.

created_at

string · date-time

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

updated_at

string · date-time

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

enable_http3

boolean

Defines whether to enable HTTP/3 protocol on the frontend.

connection_rate_limit

integer · uint32

Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.

enable_access_logs

boolean

Defines whether to enable access logs on the frontend.

PUT/lb/v1/regions/{region}/frontends/{frontend_id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "backend_id": "string",
    "enable_http3": false,
    "inbound_port": 42,
    "name": "string"
  }' \
  "https://api.scaleway.com/lb/v1/regions/{region}/frontends/{frontend_id}"

Example Request Body

{
  "name": "name",
  "inbound_port": 0,
  "backend_id": "backend_id",
  "timeout_client": 0,
  "certificate_id": "certificate_id",
  "certificate_ids": [
    "string"
  ],
  "enable_http3": true,
  "connection_rate_limit": 0,
  "enable_access_logs": true
}

Example Responses

{
  "id": "id",
  "name": "name",
  "inbound_port": 0,
  "backend": {
    "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"
  },
  "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"
  },
  "timeout_client": 300000,
  "certificate": {
    "type": "letsencryt",
    "id": "id",
    "common_name": "common_name",
    "subject_alternative_name": [
      "string"
    ],
    "fingerprint": "fingerprint",
    "not_valid_before": "2022-03-22T12:34:56.123456Z",
    "not_valid_after": "2022-03-22T12:34:56.123456Z",
    "status": "pending",
    "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"
    },
    "name": "name",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "status_details": "status_details"
  },
  "certificate_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "enable_http3": true,
  "connection_rate_limit": 0,
  "enable_access_logs": true
}

application/json

Delete a frontend

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/frontends/{frontend_id}

Delete a frontend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

frontend_id

string · required

ID of the frontend to delete.

Delete a frontend › Responses

No data returned

DELETE/lb/v1/regions/{region}/frontends/{frontend_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/frontends/{frontend_id}"

Example Responses

No example specified for this content type

List ACL for a given frontend

GET

https://api.scaleway.com

/lb/v1/regions/{region}/frontends/{frontend_id}/acls

List ACL for a given frontend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

frontend_id

string · required

Frontend ID (ACLs attached to this frontend will be returned in the response).

List ACL for a given frontend › query Parameters

order_by

string · enum

Sort order of ACLs 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 ACLs to return.

name

string

ACL name to filter for.

List ACL for a given frontend › Responses

200

scaleway.lb.v1.ListAclResponse

scaleway.lb.v1.Acl[]

List of ACL objects.

total_count

integer · uint32

The total number of objects.

GET/lb/v1/regions/{region}/frontends/{frontend_id}/acls

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/frontends/{frontend_id}/acls"

Example Responses

{
  "acls": [
    {
      "id": "id",
      "name": "name",
      "match": {
        "ip_subnet": [
          "string"
        ],
        "ips_edge_services": true,
        "http_filter": "acl_http_filter_none",
        "http_filter_value": [
          "string"
        ],
        "http_filter_option": "http_filter_option",
        "invert": true
      },
      "action": {
        "type": "allow",
        "redirect": {
          "type": "location",
          "target": "target",
          "code": 0
        }
      },
      "frontend": {
        "id": "id",
        "name": "name",
        "inbound_port": 0,
        "backend": {
          "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"
        },
        "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"
        },
        "timeout_client": 300000,
        "certificate": {
          "type": "letsencryt",
          "id": "id",
          "common_name": "common_name",
          "subject_alternative_name": [
            "string"
          ],
          "fingerprint": "fingerprint",
          "not_valid_before": "2022-03-22T12:34:56.123456Z",
          "not_valid_after": "2022-03-22T12:34:56.123456Z",
          "status": "pending",
          "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"
          },
          "name": "name",
          "created_at": "2022-03-22T12:34:56.123456Z",
          "updated_at": "2022-03-22T12:34:56.123456Z",
          "status_details": "status_details"
        },
        "certificate_ids": [
          "string"
        ],
        "created_at": "2022-03-22T12:34:56.123456Z",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "enable_http3": true,
        "connection_rate_limit": 0,
        "enable_access_logs": true
      },
      "index": 0,
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "description": "description"
    }
  ],
  "total_count": 0
}

application/json

Create an ACL for a given frontend

POST

https://api.scaleway.com

/lb/v1/regions/{region}/frontends/{frontend_id}/acls

Create an ACL for a given frontend › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

frontend_id

string · required

Frontend ID to attach the ACL to.

Create an ACL for a given frontend › Request Body

name

string · required

ACL name.

object · required

Action to take when incoming traffic matches an ACL filter.

index

integer · int32 · required

Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).

object

ACL match filter object. One of ip_subnet, ips_edge_services or http_filter & http_filter_value are required.

description

string

ACL description.

Create an ACL for a given frontend › Responses

200

scaleway.lb.v1.Acl

id

string

ACL ID.

name

string

ACL name.

object

ACL match filter object. One of ip_subnet, ips_edge_services or http_filter & http_filter_value are required.

object

Action to take when incoming traffic matches an ACL filter.

object

ACL is attached to this frontend object.

index

integer · int32

Priority of this ACL (ACLs are applied in ascending order, 0 is the first ACL executed).

created_at

string · date-time

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

updated_at

string · date-time

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

description

string

ACL description.

POST/lb/v1/regions/{region}/frontends/{frontend_id}/acls

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": {
        "redirect": {
            "code": 42,
            "target": "string",
            "type": "location"
        },
        "type": "allow"
    },
    "description": "string",
    "index": 42,
    "name": "string"
  }' \
  "https://api.scaleway.com/lb/v1/regions/{region}/frontends/{frontend_id}/acls"

Example Request Body

{
  "name": "name",
  "action": {
    "type": "allow",
    "redirect": {
      "type": "location",
      "target": "target",
      "code": 0
    }
  },
  "match": {
    "ip_subnet": [
      "string"
    ],
    "ips_edge_services": true,
    "http_filter": "acl_http_filter_none",
    "http_filter_value": [
      "string"
    ],
    "http_filter_option": "http_filter_option",
    "invert": true
  },
  "index": 0,
  "description": "description"
}

Example Responses

{
  "id": "id",
  "name": "name",
  "match": {
    "ip_subnet": [
      "string"
    ],
    "ips_edge_services": true,
    "http_filter": "acl_http_filter_none",
    "http_filter_value": [
      "string"
    ],
    "http_filter_option": "http_filter_option",
    "invert": true
  },
  "action": {
    "type": "allow",
    "redirect": {
      "type": "location",
      "target": "target",
      "code": 0
    }
  },
  "frontend": {
    "id": "id",
    "name": "name",
    "inbound_port": 0,
    "backend": {
      "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"
    },
    "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"
    },
    "timeout_client": 300000,
    "certificate": {
      "type": "letsencryt",
      "id": "id",
      "common_name": "common_name",
      "subject_alternative_name": [
        "string"
      ],
      "fingerprint": "fingerprint",
      "not_valid_before": "2022-03-22T12:34:56.123456Z",
      "not_valid_after": "2022-03-22T12:34:56.123456Z",
      "status": "pending",
      "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"
      },
      "name": "name",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "status_details": "status_details"
    },
    "certificate_ids": [
      "string"
    ],
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "enable_http3": true,
    "connection_rate_limit": 0,
    "enable_access_logs": true
  },
  "index": 0,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "description": "description"
}

application/json

List IPs

GET

https://api.scaleway.com

/lb/v1/regions/{region}/ips

List IPs › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List IPs › query Parameters

page

integer · int32

The page number to return, from the paginated results.

page_size

integer · uint32

Number of IP addresses to return.

ip_address

string

IP address to filter for.

organization_id

string

Organization ID to filter for, only Load Balancer IP addresses from this Organization will be returned.

project_id

string

Project ID to filter for, only Load Balancer IP addresses from this Project will be returned.

ip_type

string · enum

IP type to filter for.

Enum values:

all

ipv4

ipv6

Default: all

tags

string[]

Tag to filter for, only IPs with one or more matching tags will be returned.

List IPs › Responses

200

scaleway.lb.v1.ListIpsResponse

scaleway.lb.v1.ListLbTypesResponse

List of IP address objects.

total_count

integer · uint32

Total count of IP address objects, without pagination.

GET/lb/v1/regions/{region}/ips

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/ips"

Example Responses

{
  "ips": [
    {
      "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"
    }
  ],
  "total_count": 0
}

application/json

Create an IP

POST

https://api.scaleway.com

/lb/v1/regions/{region}/ips

Create an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create an IP › Request Body

project_id

string

Project ID of the Project where the IP address should be created.

reverse

string

Reverse DNS (domain name) for the IP address.

is_ipv6

boolean

If true, creates a Flexible IP with an ipv6 address.

tags

string[]

List of tags for the IP.

Create an IP › Responses

200

scaleway.lb.v1.Ip

id

string

IP address ID.

ip_address

string

IP address.

organization_id

string

Organization ID of the Scaleway Organization the IP address is in.

project_id

string

Project ID of the Scaleway Project the IP address is in.

lb_id

string

Load Balancer ID.

reverse

string

Reverse DNS (domain name) of the IP address.

tags

string[]

IP tags.

zone

string

The zone the IP address is in.

POST/lb/v1/regions/{region}/ips

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"is_ipv6":false}' \
  "https://api.scaleway.com/lb/v1/regions/{region}/ips"

Example Request Body

{
  "organization_id": "organization_id",
  "project_id": "project_id",
  "reverse": "reverse",
  "is_ipv6": true,
  "tags": [
    "string"
  ]
}

Example Responses

{
  "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"
}

application/json

Get an IP

GET

https://api.scaleway.com

/lb/v1/regions/{region}/ips/{ip_id}

Get an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

ip_id

string · required

IP address ID.

Get an IP › Responses

200

scaleway.lb.v1.Ip

id

string

IP address ID.

ip_address

string

IP address.

organization_id

string

Organization ID of the Scaleway Organization the IP address is in.

project_id

string

Project ID of the Scaleway Project the IP address is in.

lb_id

string

Load Balancer ID.

reverse

string

Reverse DNS (domain name) of the IP address.

tags

string[]

IP tags.

zone

string

The zone the IP address is in.

GET/lb/v1/regions/{region}/ips/{ip_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/ips/{ip_id}"

Example Responses

{
  "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"
}

application/json

Delete an IP

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/ips/{ip_id}

Delete an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

ip_id

string · required

IP address ID.

Delete an IP › Responses

No data returned

DELETE/lb/v1/regions/{region}/ips/{ip_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/ips/{ip_id}"

Example Responses

No example specified for this content type

Update an IP

PATCH

https://api.scaleway.com

/lb/v1/regions/{region}/ips/{ip_id}

Update an IP › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

ip_id

string · required

IP address ID.

Update an IP › Request Body

reverse

string

Reverse DNS (domain name) for the IP address.

lb_id

string

ID of the server on which to attach the flexible IP.

tags

string[]

List of tags for the IP.

Update an IP › Responses

200

scaleway.lb.v1.Ip

id

string

IP address ID.

ip_address

string

IP address.

organization_id

string

Organization ID of the Scaleway Organization the IP address is in.

project_id

string

Project ID of the Scaleway Project the IP address is in.

lb_id

string

Load Balancer ID.

reverse

string

Reverse DNS (domain name) of the IP address.

tags

string[]

IP tags.

zone

string

The zone the IP address is in.

PATCH/lb/v1/regions/{region}/ips/{ip_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/lb/v1/regions/{region}/ips/{ip_id}"

Example Request Body

{
  "reverse": "reverse",
  "lb_id": "lb_id",
  "tags": [
    "string"
  ]
}

Example Responses

{
  "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"
}

application/json

List all load balancer offer type

GET

https://api.scaleway.com

/lb/v1/regions/{region}/lb-types

List all load balancer offer type › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List all load balancer offer type › query Parameters

page

integer · int32

The page number to return, from the paginated results.

page_size

integer · uint32

The number of items to return.

List all load balancer offer type › Responses

200

scaleway.lb.v1.LbType[]

List of Load Balancer commercial offer type objects.

total_count

integer · uint32

Total number of Load Balancer offer type objects.

GET/lb/v1/regions/{region}/lb-types

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/lb-types"

Example Responses

{
  "lb_types": [
    {
      "name": "name",
      "stock_status": "unknown",
      "bandwidth": 0,
      "multicloud": true,
      "description": "description",
      "region": "region",
      "zone": "zone"
    }
  ],
  "total_count": 0
}

application/json

POST

https://api.scaleway.com

/lb/v1/regions/{region}/lb/{lb_id}/subscribe

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

subscriber_id

string · required

Subscriber ID.

200

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

string · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.

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.

object

Subscriber information.

ssl_compatibility_level

string · 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 · date-time

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

updated_at

string · 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/regions/{region}/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/regions/{region}/lb/{lb_id}/subscribe"

Example Request Body

{
  "subscriber_id": "subscriber_id"
}

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"
}

application/json

Unsubscribe a subscriber from a given load balancer

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/lb/{lb_id}/unsubscribe

Unsubscribe a subscriber from a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

Unsubscribe a subscriber from a given load balancer › Responses

200

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

string · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.

scaleway.lb.v1.ListLbsResponse

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.

object

Subscriber information.

ssl_compatibility_level

string · 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 · date-time

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

updated_at

string · 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/regions/{region}/lb/{lb_id}/unsubscribe

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/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"
}

application/json

Delete a subscriber

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/lb/subscriber/{subscriber_id}

Delete a subscriber › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

subscriber_id

string · required

Subscriber ID.

Delete a subscriber › Responses

No data returned

DELETE/lb/v1/regions/{region}/lb/subscriber/{subscriber_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/lb/subscriber/{subscriber_id}"

Example Responses

No example specified for this content type

List load balancers

GET

https://api.scaleway.com

/lb/v1/regions/{region}/lbs

List load balancers › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List load balancers › query Parameters

name

string

Load Balancer name to filter for.

order_by

string · enum

Sort order of Load Balancers in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

page_size

integer · uint32

Number of Load Balancers to return.

page

integer · int32

Page number to return, from the paginated results.

organization_id

string

Organization ID to filter for, only Load Balancers from this Organization will be returned.

project_id

string

Project ID to filter for, only Load Balancers from this Project will be returned.

tags

string[]

Filter by tag, only Load Balancers with one or more matching tags will be returned.

List load balancers › Responses

200

scaleway.lb.v1.Lb[]

List of Load Balancer objects.

total_count

integer · uint32

The total number of Load Balancer objects.

GET/lb/v1/regions/{region}/lbs

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/lbs"

Example Responses

{
  "lbs": [
    {
      "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"
    }
  ],
  "total_count": 0
}

application/json

Create a load balancer

POST

https://api.scaleway.com

/lb/v1/regions/{region}/lbs

Create a load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a load balancer › Request Body

name

string · required

Name for the Load Balancer.

project_id

string

Scaleway Project to create the Load Balancer in.

description

string

Description for the Load Balancer.

assign_flexible_ip

boolean

Defines whether to automatically assign a flexible public IP to the Load Balancer. Default value is true (assign).

assign_flexible_ipv6

boolean

Defines whether to automatically assign a flexible public IPv6 to the Load Balancer. Default value is false (do not assign).

ip_ids

string[]

List of IP IDs to attach to the Load Balancer.

tags

string[]

List of tags for the Load Balancer.

type

string

Load Balancer commercial offer type. Use the Load Balancer types endpoint to retrieve a list of available offer types.

ssl_compatibility_level

string · enum

Determines the minimal SSL version which needs to be supported on the client side, in an SSL/TLS offloading context. Intermediate is suitable for general-purpose servers with a variety of clients, recommended for almost all systems (>= TLS1.2). Modern is suitable for services with clients that support TLS 1.3 and do not need backward compatibility (= TLS1.3). Old is compatible with a small number of very old clients and should be used only as a last resort (>= TLS1.0).

Enum values:

ssl_compatibility_level_unknown

ssl_compatibility_level_intermediate

ssl_compatibility_level_modern

ssl_compatibility_level_old

Default: ssl_compatibility_level_unknown

Create a load balancer › Responses

200

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

string · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.

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.

object

Subscriber information.

ssl_compatibility_level

string · 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 · date-time

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

updated_at

string · 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/regions/{region}/lbs

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "name": "string",
    "type": "string"
  }' \
  "https://api.scaleway.com/lb/v1/regions/{region}/lbs"

Example Request Body

{
  "organization_id": "organization_id",
  "project_id": "project_id",
  "name": "name",
  "description": "description",
  "ip_id": "ip_id",
  "assign_flexible_ip": true,
  "assign_flexible_ipv6": true,
  "ip_ids": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "type": "type",
  "ssl_compatibility_level": "ssl_compatibility_level_unknown"
}

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"
}

application/json

Get a load balancer

GET

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}

Get a load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

Get a load balancer › Responses

200

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

string · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.

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.

object

Subscriber information.

ssl_compatibility_level

string · 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 · date-time

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

updated_at

string · 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.

GET/lb/v1/regions/{region}/lbs/{lb_id}

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

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"
}

application/json

Update a load balancer

PUT

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}

Update a load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

Update a load balancer › Request Body

name

string · required

Load Balancer name.

description

string · required

Load Balancer description.

tags

string[]

List of tags for the Load Balancer.

ssl_compatibility_level

string · enum

Enum values:

ssl_compatibility_level_unknown

ssl_compatibility_level_intermediate

ssl_compatibility_level_modern

ssl_compatibility_level_old

Default: ssl_compatibility_level_unknown

Update a load balancer › Responses

200

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

string · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.

scaleway.lb.v1.ListBackendStatsResponse

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.

object

Subscriber information.

ssl_compatibility_level

string · 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 · date-time

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

updated_at

string · 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.

PUT/lb/v1/regions/{region}/lbs/{lb_id}

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description":"string","name":"string"}' \
  "https://api.scaleway.com/lb/v1/regions/{region}/lbs/{lb_id}"

Example Request Body

{
  "name": "name",
  "description": "description",
  "tags": [
    "string"
  ],
  "ssl_compatibility_level": "ssl_compatibility_level_unknown"
}

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"
}

application/json

Delete a load balancer

DELETE

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}

Delete a load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

ID of the Load Balancer to delete.

Delete a load balancer › query Parameters

release_ip

boolean · required

Defines whether the Load Balancer's flexible IP should be deleted. Set to true to release the flexible IP, or false to keep it available in your account for future Load Balancers.

Delete a load balancer › Responses

No data returned

DELETE/lb/v1/regions/{region}/lbs/{lb_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/lbs/{lb_id}?release_ip=false"

Example Responses

No example specified for this content type

List backend server statistics

GET

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/backend-stats

List backend server statistics › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

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.BackendServerStats[]

List of objects containing backend server statistics.

total_count

integer · uint32

The total number of objects.

GET/lb/v1/regions/{region}/lbs/{lb_id}/backend-stats

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/lbs/{lb_id}/backend-stats"

Example Responses

{
  "backend_servers_stats": [
    {
      "instance_id": "instance_id",
      "backend_id": "backend_id",
      "ip": "ip",
      "server_state": "stopped",
      "server_state_changed_at": "2022-03-22T12:34:56.123456Z",
      "last_health_check_status": "unknown"
    }
  ],
  "total_count": 0
}

application/json

List backends in a given load balancer

GET

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/backends

List backends in a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

List backends in 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 backends in 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/regions/{region}/lbs/{lb_id}/backends

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/lb/v1/regions/{region}/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
}

application/json

Create a backend in a given load balancer

POST

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/backends

Create a backend in a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

Create a backend in 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 in a given load balancer › Responses

200

scaleway.lb.v1.ListCertificatesResponse

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/regions/{region}/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/regions/{region}/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"
}

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"
}

application/json

List all TLS certificates on a given load balancer

GET

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/certificates

List all TLS certificates on a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

List all TLS certificates on a given load balancer › query Parameters

order_by

string · enum

Sort order of certificates 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 certificates to return.

name

string

Certificate name to filter for, only certificates of this name will be returned.

List all TLS certificates on a given load balancer › Responses

200

scaleway.lb.v1.Certificate[]

List of certificate objects.

total_count

integer · uint32

The total number of objects.

GET/lb/v1/regions/{region}/lbs/{lb_id}/certificates

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

Example Responses

{
  "certificates": [
    {
      "type": "letsencryt",
      "id": "id",
      "common_name": "common_name",
      "subject_alternative_name": [
        "string"
      ],
      "fingerprint": "fingerprint",
      "not_valid_before": "2022-03-22T12:34:56.123456Z",
      "not_valid_after": "2022-03-22T12:34:56.123456Z",
      "status": "pending",
      "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"
      },
      "name": "name",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "status_details": "status_details"
    }
  ],
  "total_count": 0
}

application/json

Create a TLS certificate

POST

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/certificates

Generate a new TLS certificate using Let's Encrypt or import your certificate.

Create a TLS certificate › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

Create a TLS certificate › Request Body

name

string · required

Name for the certificate.

object

Object to define a new Let's Encrypt certificate to be generated.

object

Object to define an existing custom certificate to be imported.

Create a TLS certificate › Responses

200

scaleway.lb.v1.Certificate

type

string · enum

Certificate type (Let's Encrypt or custom).

Enum values:

letsencryt

custom

letsencrypt

Default: letsencryt

id

string

Certificate ID.

common_name

string

Main domain name of certificate.

subject_alternative_name

string[]

Alternative domain names.

fingerprint

string

Identifier (SHA-1) of the certificate.

not_valid_before

string · date-time

Lower validity bound. (RFC 3339 format)

not_valid_after

string · date-time

Upper validity bound. (RFC 3339 format)

status

string · enum

Certificate status.

Enum values:

pending

ready

error

Default: pending

object

Load Balancer object the certificate is attached to.

name

string

Certificate name.

created_at

string · date-time

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

updated_at

string · date-time

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

status_details

string

Additional information about the certificate status (useful in case of certificate generation failure, for example).

POST/lb/v1/regions/{region}/lbs/{lb_id}/certificates

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/lb/v1/regions/{region}/lbs/{lb_id}/certificates"

Example Request Body

{
  "name": "name",
  "letsencrypt": {
    "common_name": "common_name",
    "subject_alternative_name": [
      "string"
    ]
  },
  "custom_certificate": {
    "certificate_chain": "certificate_chain"
  }
}

Example Responses

{
  "type": "letsencryt",
  "id": "id",
  "common_name": "common_name",
  "subject_alternative_name": [
    "string"
  ],
  "fingerprint": "fingerprint",
  "not_valid_before": "2022-03-22T12:34:56.123456Z",
  "not_valid_after": "2022-03-22T12:34:56.123456Z",
  "status": "pending",
  "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"
  },
  "name": "name",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status_details": "status_details"
}

application/json

List frontends in a given load balancer

GET

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/frontends

List frontends in a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

List frontends in a given load balancer › query Parameters

name

string

Name of the frontend to filter for.

order_by

string · enum

Sort order of frontends 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 frontends to return.

List frontends in a given load balancer › Responses

200

scaleway.lb.v1.ListFrontendsResponse

scaleway.lb.v1.Frontend[]

List of frontend objects of a given Load Balancer.

total_count

integer · uint32

Total count of frontend objects, without pagination.

GET/lb/v1/regions/{region}/lbs/{lb_id}/frontends

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

Example Responses

{
  "frontends": [
    {
      "id": "id",
      "name": "name",
      "inbound_port": 0,
      "backend": {
        "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"
      },
      "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"
      },
      "timeout_client": 300000,
      "certificate": {
        "type": "letsencryt",
        "id": "id",
        "common_name": "common_name",
        "subject_alternative_name": [
          "string"
        ],
        "fingerprint": "fingerprint",
        "not_valid_before": "2022-03-22T12:34:56.123456Z",
        "not_valid_after": "2022-03-22T12:34:56.123456Z",
        "status": "pending",
        "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"
        },
        "name": "name",
        "created_at": "2022-03-22T12:34:56.123456Z",
        "updated_at": "2022-03-22T12:34:56.123456Z",
        "status_details": "status_details"
      },
      "certificate_ids": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "enable_http3": true,
      "connection_rate_limit": 0,
      "enable_access_logs": true
    }
  ],
  "total_count": 0
}

application/json

Create a frontend in a given load balancer

POST

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/frontends

Create a frontend in a given load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID (ID of the Load Balancer to attach the frontend to).

Create a frontend in a given load balancer › Request Body

name

string · required

Name for the frontend.

inbound_port

integer · int32 · required

Port the frontend should listen on.

backend_id

string · required

Backend ID (ID of the backend the frontend should pass traffic to).

timeout_client

number

Maximum allowed inactivity time on the client side. (in milliseconds)

certificate_ids

string[]

List of SSL/TLS certificate IDs to bind to the frontend.

enable_http3

boolean

Defines whether to enable HTTP/3 protocol on the frontend.

connection_rate_limit

integer · uint32

Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.

enable_access_logs

boolean

Defines whether to enable access logs on the frontend.

Create a frontend in a given load balancer › Responses

200

scaleway.lb.v1.Frontend

id

string

Frontend ID.

name

string

Name of the frontend.

inbound_port

integer · int32

Port the frontend listens on.

object

Backend object the frontend is attached to.

object

Load Balancer object the frontend is attached to.

timeout_client

number

Maximum allowed inactivity time on the client side. (in milliseconds)

Default: 300000

certificate_ids

string[]

List of SSL/TLS certificate IDs to bind to the frontend.

created_at

string · date-time

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

updated_at

string · date-time

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

enable_http3

boolean

Defines whether to enable HTTP/3 protocol on the frontend.

connection_rate_limit

integer · uint32

Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.

enable_access_logs

boolean

Defines whether to enable access logs on the frontend.

POST/lb/v1/regions/{region}/lbs/{lb_id}/frontends

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "backend_id": "string",
    "enable_access_logs": false,
    "enable_http3": false,
    "inbound_port": 42,
    "name": "string"
  }' \
  "https://api.scaleway.com/lb/v1/regions/{region}/lbs/{lb_id}/frontends"

Example Request Body

{
  "name": "name",
  "inbound_port": 0,
  "backend_id": "backend_id",
  "timeout_client": 0,
  "certificate_id": "certificate_id",
  "certificate_ids": [
    "string"
  ],
  "enable_http3": true,
  "connection_rate_limit": 0,
  "enable_access_logs": true
}

Example Responses

{
  "id": "id",
  "name": "name",
  "inbound_port": 0,
  "backend": {
    "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"
  },
  "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"
  },
  "timeout_client": 300000,
  "certificate": {
    "type": "letsencryt",
    "id": "id",
    "common_name": "common_name",
    "subject_alternative_name": [
      "string"
    ],
    "fingerprint": "fingerprint",
    "not_valid_before": "2022-03-22T12:34:56.123456Z",
    "not_valid_after": "2022-03-22T12:34:56.123456Z",
    "status": "pending",
    "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"
    },
    "name": "name",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "status_details": "status_details"
  },
  "certificate_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "enable_http3": true,
  "connection_rate_limit": 0,
  "enable_access_logs": true
}

application/json

Migrate a load balancer

POST

https://api.scaleway.com

/lb/v1/regions/{region}/lbs/{lb_id}/migrate

Migrate a load balancer › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

lb_id

string · required

Load Balancer ID.

Migrate a load balancer › Request Body

type

string · required

Load Balancer type to migrate to (use the List all Load Balancer offer types endpoint to get a list of available offer types).

Migrate a load balancer › Responses

200

id

string

Underlying Instance ID.

name

string

Load Balancer name.

description

string

Load Balancer description.

status

string · enum

Load Balancer status.

Enum values:

unknown

ready

pending

stopped

error

locked

migrating

to_create

Default: unknown

List of underlying Instances.

organization_id

string

Scaleway Organization ID.

project_id

string

Scaleway Project ID.