Frontends

Download schema

The Load Balancer frontend object. It listens on a configured port and forward requests to one or several backends. You can create multiple frontends for any given Load Balancer, each listening on a different port, and choose to add certificates to them if you wish. Use the frontends endpoint to create, list, manage and delete frontends.

Get a frontend

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/frontends/{frontend_id}

Get the full details of a given frontend, specified by its frontend ID. The response contains the frontend's full configuration parameters including the backend it is attached to, the port it listens on, and any certificates it has.

Get a frontend › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

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.

scaleway.lb.v1.Backend

Backend object the frontend is attached to.

scaleway.lb.v1.Lb

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

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

updated_at

string | null · 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 | null · 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/zones/{zone}/frontends/{frontend_id}

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

json

application/json

Update a frontend

PUT

https://api.scaleway.com

/lb/v1/zones/{zone}/frontends/{frontend_id}

Update a given frontend, specified by its frontend ID. You can update configuration parameters including its name and the port it listens on. Note that the request type is PUT and not PATCH. You must set all parameters.

Update a frontend › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

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

array | null

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 | null · 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 | null

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.

scaleway.lb.v1.Backend

Backend object the frontend is attached to.

scaleway.lb.v1.Lb

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

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

updated_at

string | null · 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 | null · 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/zones/{zone}/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/zones/{zone}/frontends/{frontend_id}"

Example Request Body

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

json

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",
    "host": "host"
  },
  "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
}

json

application/json

Delete a frontend

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/frontends/{frontend_id}

Delete a given frontend, specified by its frontend ID. This action is irreversible and cannot be undone.

Delete a frontend › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

frontend_id

string · required

ID of the frontend to delete.

Delete a frontend › Responses

No data returned

List frontends of a given Load Balancer

GET

https://api.scaleway.com

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

List all the frontends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each frontend. The response is an array of frontend objects, containing full details of each one including the port they listen on and the backend they are attached to.

List frontends of a given Load Balancer › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID.

List frontends of a given Load Balancer › query Parameters

name

string

Name of the frontend to filter for.

order_by

scaleway.lb.v1.ListFrontendsRequest.OrderBy · 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 of 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/zones/{zone}/lbs/{lb_id}/frontends

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

json

application/json

Create a frontend in a given Load Balancer

POST

https://api.scaleway.com

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

Create a new frontend for a given Load Balancer, specifying its configuration including the port it should listen on and the backend to attach it to.

Create a frontend in a given Load Balancer › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID (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

array | null

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

scaleway.lb.v1.Backend

Backend object the frontend is attached to.

scaleway.lb.v1.Lb

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

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

updated_at

string | null · 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 | null · 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/zones/{zone}/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/zones/{zone}/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": [],
  "enable_http3": true,
  "connection_rate_limit": 0,
  "enable_access_logs": true
}

json

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",
    "host": "host"
  },
  "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
}

json

application/json

Load Balancer Backends