Ingress Rules

Download schema

An Ingress rule (or ingress routing rule) matches packets coming into your VPC through VPC Connectors, and redirects the traffic to a local resource (usually a firewall or router).

List ingress rules

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules

List existing ingress rules in the specified region.

List ingress rules › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List ingress rules › query Parameters

order_by

string · enum

Sort order of the returned ingress rules.

Enum values:

created_at_asc

created_at_desc

source_asc

source_desc

prefix_len_asc

prefix_len_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of ingress rules to return per page.

vpc_id

string

ID of the VPC to filter for. (UUID format)

nexthop_resource_ip

string

Next hop IP to filter for. (IP address)

nexthop_private_network_id

string

Next hop Private Network ID to filter for. Only ingress rules with this Private Network as next hop will be returned. (UUID format)

is_ipv6

boolean

Whether to return only IPv4 or IPv6 ingress rules.

tags

string[]

Tags to filter for. Only ingress rules with one or more matching tags will be returned.

organization_id

string

Organization ID to filter for. Only ingress rules belonging to this Organization will be returned. (UUID format)

project_id

string

Project ID to filter for. Only ingress rules belonging to this Project will be returned. (UUID format)

List ingress rules › Responses

200

scaleway.vpc.v2.ListIngressRulesResponse

scaleway.vpc.v2.IngressRule[]

total_count

integer · uint64

GET/vpc/v2/regions/{region}/ingress-rules

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc/v2/regions/{region}/ingress-rules"

Example Responses

{
  "rules": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "is_ipv6": true,
      "source": "1.2.3.4/32",
      "nexthop_resource_ip": "1.2.3.4",
      "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "description": "description",
      "tags": [
        "string"
      ],
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "region": "region"
    }
  ],
  "total_count": 0
}

json

application/json

Create an ingress rule

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules

Create an ingress rule in the specified region.

Create an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create an ingress rule › Request Body

vpc_id

string · required

ID of the VPC this rule will belong to. (UUID format)

source

string · required

Source network to match ingress traffic on. Can be IPv6 or IPv4. (IP network)

nexthop_resource_ip

string · required

IP of the local resource to redirect ingress traffic to. IP version must be consistent with the source network. (IP address)

nexthop_private_network_id

string · required

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description for this ingress rule.

tags

string[]

Tags for this ingress rule.

Create an ingress rule › Responses

200

scaleway.vpc.v2.IngressRule

id

string

ID of the ingress rule. (UUID format)

vpc_id

string

ID of the VPC this rule belongs to. (UUID format)

created_at

string · date-time

Date the ingress rule was created. (RFC 3339 format)

updated_at

string · date-time

Date the ingress rule was last modified. (RFC 3339 format)

is_ipv6

boolean

Whether this rule applies to IPv4 or IPv6 traffic.

source

string

Source network to apply this rule on. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description of this ingress rule.

tags

string[]

Tags of this ingress rule.

organization_id

string

Scaleway Organization the ingress rule belongs to. (UUID format)

project_id

string

Scaleway Project the ingress rule belongs to. (UUID format)

region

string

Region of the ingress rule.

POST/vpc/v2/regions/{region}/ingress-rules

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
    "nexthop_resource_ip": "1.2.3.4",
    "source": "1.2.3.4/32",
    "vpc_id": "6170692e-7363-616c-6577-61792e636f6d"
  }' \
  "https://api.scaleway.com/vpc/v2/regions/{region}/ingress-rules"

Example Request Body

{
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "source": "1.2.3.4/32",
  "nexthop_resource_ip": "1.2.3.4",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "is_ipv6": true,
  "source": "1.2.3.4/32",
  "nexthop_resource_ip": "1.2.3.4",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "tags": [
    "string"
  ],
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region"
}

json

application/json

Get an ingress rule

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules/{rule_id}

Retrieve details of an existing ingress rule, specified by its ingress rule ID.

Get an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

rule_id

string · required

ID of the ingress rule to return. (UUID format)

Get an ingress rule › Responses

200

scaleway.vpc.v2.IngressRule

id

string

ID of the ingress rule. (UUID format)

vpc_id

string

ID of the VPC this rule belongs to. (UUID format)

created_at

string · date-time

Date the ingress rule was created. (RFC 3339 format)

updated_at

string · date-time

Date the ingress rule was last modified. (RFC 3339 format)

is_ipv6

boolean

Whether this rule applies to IPv4 or IPv6 traffic.

source

string

Source network to apply this rule on. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description of this ingress rule.

tags

string[]

Tags of this ingress rule.

organization_id

string

Scaleway Organization the ingress rule belongs to. (UUID format)

project_id

string

Scaleway Project the ingress rule belongs to. (UUID format)

region

string

Region of the ingress rule.

Delete an ingress rule

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules/{rule_id}

Delete an ingress rule specified by its ingress rule ID.

Delete an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

rule_id

string · required

ID of the ingress rule to delete. (UUID format)

Delete an ingress rule › Responses

No data returned

Update an ingress rule

PATCH

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules/{rule_id}

Update an ingress rule specified by its ingress rule ID.

Update an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

rule_id

string · required

ID of the ingress rule to update. (UUID format)

Update an ingress rule › Request Body

source

string

Source network to match ingress traffic on. Can be IPv4 or IPv6. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. IP version must be consistent with the source network. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description to set for this ingress rule.

tags

string[]

Tags to set for this ingress rule.

Update an ingress rule › Responses

200

scaleway.vpc.v2.IngressRule

id

string

ID of the ingress rule. (UUID format)

vpc_id

string

ID of the VPC this rule belongs to. (UUID format)

created_at

string · date-time

Date the ingress rule was created. (RFC 3339 format)

updated_at

string · date-time

Date the ingress rule was last modified. (RFC 3339 format)

is_ipv6

boolean

Whether this rule applies to IPv4 or IPv6 traffic.

source

string

Source network to apply this rule on. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description of this ingress rule.

tags

string[]

Tags of this ingress rule.

organization_id

string

Scaleway Organization the ingress rule belongs to. (UUID format)

project_id

string

Scaleway Project the ingress rule belongs to. (UUID format)

region

string

Region of the ingress rule.

PATCH/vpc/v2/regions/{region}/ingress-rules/{rule_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/vpc/v2/regions/{region}/ingress-rules/{rule_id}"

Example Request Body

{
  "source": "1.2.3.4/32",
  "nexthop_resource_ip": "1.2.3.4",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "is_ipv6": true,
  "source": "1.2.3.4/32",
  "nexthop_resource_ip": "1.2.3.4",
  "nexthop_private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "description": "description",
  "tags": [
    "string"
  ],
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region"
}

json

application/json

VPC Connectors S3 integration

List ingress rules

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules

List existing ingress rules in the specified region.

List ingress rules › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

List ingress rules › query Parameters

order_by

string · enum

Sort order of the returned ingress rules.

Enum values:

created_at_asc

created_at_desc

source_asc

source_desc

prefix_len_asc

prefix_len_desc

Default: created_at_asc

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Maximum number of ingress rules to return per page.

vpc_id

string

ID of the VPC to filter for. (UUID format)

nexthop_resource_ip

string

Next hop IP to filter for. (IP address)

nexthop_private_network_id

string

Next hop Private Network ID to filter for. Only ingress rules with this Private Network as next hop will be returned. (UUID format)

is_ipv6

boolean

Whether to return only IPv4 or IPv6 ingress rules.

tags

string[]

Tags to filter for. Only ingress rules with one or more matching tags will be returned.

organization_id

string

Organization ID to filter for. Only ingress rules belonging to this Organization will be returned. (UUID format)

project_id

string

Project ID to filter for. Only ingress rules belonging to this Project will be returned. (UUID format)

List ingress rules › Responses

200

scaleway.vpc.v2.ListIngressRulesResponse

scaleway.vpc.v2.IngressRule[]

total_count

integer · uint64

Create an ingress rule

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules

Create an ingress rule in the specified region.

Create an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Create an ingress rule › Request Body

vpc_id

string · required

ID of the VPC this rule will belong to. (UUID format)

source

string · required

Source network to match ingress traffic on. Can be IPv6 or IPv4. (IP network)

nexthop_resource_ip

string · required

IP of the local resource to redirect ingress traffic to. IP version must be consistent with the source network. (IP address)

nexthop_private_network_id

string · required

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description for this ingress rule.

tags

string[]

Tags for this ingress rule.

Create an ingress rule › Responses

200

scaleway.vpc.v2.IngressRule

id

string

ID of the ingress rule. (UUID format)

vpc_id

string

ID of the VPC this rule belongs to. (UUID format)

created_at

string · date-time

Date the ingress rule was created. (RFC 3339 format)

updated_at

string · date-time

Date the ingress rule was last modified. (RFC 3339 format)

is_ipv6

boolean

Whether this rule applies to IPv4 or IPv6 traffic.

source

string

Source network to apply this rule on. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description of this ingress rule.

tags

string[]

Tags of this ingress rule.

organization_id

string

Scaleway Organization the ingress rule belongs to. (UUID format)

project_id

string

Scaleway Project the ingress rule belongs to. (UUID format)

region

string

Region of the ingress rule.

Get an ingress rule

GET

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules/{rule_id}

Retrieve details of an existing ingress rule, specified by its ingress rule ID.

Get an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

rule_id

string · required

ID of the ingress rule to return. (UUID format)

Get an ingress rule › Responses

200

scaleway.vpc.v2.IngressRule

id

string

ID of the ingress rule. (UUID format)

vpc_id

string

ID of the VPC this rule belongs to. (UUID format)

created_at

string · date-time

Date the ingress rule was created. (RFC 3339 format)

updated_at

string · date-time

Date the ingress rule was last modified. (RFC 3339 format)

is_ipv6

boolean

Whether this rule applies to IPv4 or IPv6 traffic.

source

string

Source network to apply this rule on. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description of this ingress rule.

tags

string[]

Tags of this ingress rule.

organization_id

string

Scaleway Organization the ingress rule belongs to. (UUID format)

project_id

string

Scaleway Project the ingress rule belongs to. (UUID format)

region

string

Region of the ingress rule.

Delete an ingress rule

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules/{rule_id}

Delete an ingress rule specified by its ingress rule ID.

Delete an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

rule_id

string · required

ID of the ingress rule to delete. (UUID format)

Delete an ingress rule › Responses

No data returned

Update an ingress rule

PATCH

https://api.scaleway.com

/vpc/v2/regions/{region}/ingress-rules/{rule_id}

Update an ingress rule specified by its ingress rule ID.

Update an ingress rule › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

rule_id

string · required

ID of the ingress rule to update. (UUID format)

Update an ingress rule › Request Body

source

string

Source network to match ingress traffic on. Can be IPv4 or IPv6. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. IP version must be consistent with the source network. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description to set for this ingress rule.

tags

string[]

Tags to set for this ingress rule.

Update an ingress rule › Responses

200

scaleway.vpc.v2.IngressRule

id

string

ID of the ingress rule. (UUID format)

vpc_id

string

ID of the VPC this rule belongs to. (UUID format)

created_at

string · date-time

Date the ingress rule was created. (RFC 3339 format)

updated_at

string · date-time

Date the ingress rule was last modified. (RFC 3339 format)

is_ipv6

boolean

Whether this rule applies to IPv4 or IPv6 traffic.

source

string

Source network to apply this rule on. (IP network)

nexthop_resource_ip

string

IP of the local resource to redirect ingress traffic to. (IP address)

nexthop_private_network_id

string

ID of the Private Network the destination resource is in. (UUID format)

description

string

Description of this ingress rule.

tags

string[]

Tags of this ingress rule.

organization_id

string

Scaleway Organization the ingress rule belongs to. (UUID format)

project_id

string

Scaleway Project the ingress rule belongs to. (UUID format)

region

string

Region of the ingress rule.