Other endpoints

Download schema

GET

https://api.scaleway.com

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

path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

query Parameters

order_by

scaleway.vpc.v2.ListIngressRulesRequest.OrderBy · enum

Enum values:

created_at_asc

created_at_desc

source_asc

source_desc

prefix_len_asc

prefix_len_desc

Default: created_at_asc

page

google.protobuf.Int32Value · int32

page_size

integer · uint32

vpc_id

string

(UUID format)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

is_ipv6

google.protobuf.BoolValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

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

POST

https://api.scaleway.com

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

path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Request Body

vpc_id

string

(UUID format)

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

Responses

200

scaleway.vpc.v2.IngressRule

id

string

(UUID format)

vpc_id

string

(UUID format)

created_at

string · date-time

(RFC 3339 format)

updated_at

string · date-time

(RFC 3339 format)

is_ipv6

boolean

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

region

string

The region you want to target

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

https://api.scaleway.com

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

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

(UUID format)

Responses

200

scaleway.vpc.v2.IngressRule

id

string

(UUID format)

vpc_id

string

(UUID format)

created_at

string · date-time

(RFC 3339 format)

updated_at

string · date-time

(RFC 3339 format)

is_ipv6

boolean

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

region

string

The region you want to target

DELETE

https://api.scaleway.com

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

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

(UUID format)

Responses

No data returned

PATCH

https://api.scaleway.com

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

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

(UUID format)

Request Body

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

Responses

200

scaleway.vpc.v2.IngressRule

id

string

(UUID format)

vpc_id

string

(UUID format)

created_at

string · date-time

(RFC 3339 format)

updated_at

string · date-time

(RFC 3339 format)

is_ipv6

boolean

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

region

string

The region you want to target

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

VPC API

Other endpoints

Download schema

GET

https://api.scaleway.com

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

path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

query Parameters

order_by

scaleway.vpc.v2.ListIngressRulesRequest.OrderBy · enum

Enum values:

created_at_asc

created_at_desc

source_asc

source_desc

prefix_len_asc

prefix_len_desc

Default: created_at_asc

page

google.protobuf.Int32Value · int32

page_size

integer · uint32

vpc_id

string

(UUID format)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

is_ipv6

google.protobuf.BoolValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

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

POST

https://api.scaleway.com

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

path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

Request Body

vpc_id

string

(UUID format)

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

Responses

200

scaleway.vpc.v2.IngressRule

id

string

(UUID format)

vpc_id

string

(UUID format)

created_at

string · date-time

(RFC 3339 format)

updated_at

string · date-time

(RFC 3339 format)

is_ipv6

boolean

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

region

string

The region you want to target

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

https://api.scaleway.com

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

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

(UUID format)

Responses

200

scaleway.vpc.v2.IngressRule

id

string

(UUID format)

vpc_id

string

(UUID format)

created_at

string · date-time

(RFC 3339 format)

updated_at

string · date-time

(RFC 3339 format)

is_ipv6

boolean

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

region

string

The region you want to target

DELETE

https://api.scaleway.com

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

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

(UUID format)

Responses

No data returned

PATCH

https://api.scaleway.com

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

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

(UUID format)

Request Body

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

Responses

200

scaleway.vpc.v2.IngressRule

id

string

(UUID format)

vpc_id

string

(UUID format)

created_at

string · date-time

(RFC 3339 format)

updated_at

string · date-time

(RFC 3339 format)

is_ipv6

boolean

source

string

(IP network)

nexthop_resource_ip

string

(IP address)

nexthop_private_network_id

string

(UUID format)

description

google.protobuf.StringValue

tags

string[]

organization_id

string

(UUID format)

project_id

string

(UUID format)

region

string

The region you want to target

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