ACLs

Download schema

The Load Balancer ACL object. It represents an Access Control List rule, which tells a given frontend to allow or deny incoming traffic based on the traffic's source IP address and/or HTTP path and header. Use this endpoint to create, list, get, update and delete ACLs.

Get an ACL

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/acls/{acl_id}

Get information for a particular ACL, specified by its ACL ID. The response returns full details of the ACL, including its name, action, match rule and frontend.

Get an ACL › 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

acl_id

string · required

ACL ID.

Get an ACL › 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.

GET/lb/v1/zones/{zone}/acls/{acl_id}

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

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

json

application/json

Update an ACL

PUT

https://api.scaleway.com

/lb/v1/zones/{zone}/acls/{acl_id}

Update a particular ACL, specified by its ACL ID. You can update details including its name, action and match rule.

Update an ACL › 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

acl_id

string · required

ACL ID.

Update an ACL › 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.

Update an ACL › 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.

PUT/lb/v1/zones/{zone}/acls/{acl_id}

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

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

json

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

json

application/json

Delete an ACL

DELETE

https://api.scaleway.com

/lb/v1/zones/{zone}/acls/{acl_id}

Delete an ACL, specified by its ACL ID. Deleting an ACL is irreversible and cannot be undone.

Delete an ACL › 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

acl_id

string · required

ACL ID.

Delete an ACL › Responses

No data returned

List ACLs for a given frontend

GET

https://api.scaleway.com

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

List the ACLs for a given frontend, specified by its frontend ID. The response is an array of ACL objects, each one representing an ACL that denies or allows traffic based on certain conditions.

List ACLs for a given 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 (ACLs attached to this frontend will be returned in the response).

List ACLs 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 ACLs 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/zones/{zone}/frontends/{frontend_id}/acls

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

json

application/json

Define all ACLs for a given frontend

PUT

https://api.scaleway.com

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

For a given frontend specified by its frontend ID, define and add the complete set of ACLS for that frontend. Any existing ACLs on this frontend will be removed.

Define all ACLs for a given 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.

Define all ACLs for a given frontend › Request Body

scaleway.lb.v1.AclSpec[] · required

List of ACLs for this frontend. Any other existing ACLs on this frontend will be removed.

Define all ACLs for a given frontend › Responses

200

scaleway.lb.v1.SetAclsResponse

scaleway.lb.v1.Acl[]

List of ACL objects.

total_count

integer · uint32

The total number of ACL objects.

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

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

Example Request Body

{
  "acls": [
    {
      "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"
    }
  ]
}

json

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
}

json

application/json

Create an ACL for a given frontend

POST

https://api.scaleway.com

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

Create a new ACL for a given frontend. Each ACL must have a name, an action to perform (allow or deny), and a match rule (the action is carried out when the incoming traffic matches the rule).

Create an ACL for a given 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 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/zones/{zone}/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/zones/{zone}/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"
}

json

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

json

application/json

Stats Certificate