Gateways

id

string

ID of the gateway. (UUID format)

srn

string

The SRN of the gateway.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

Gateway creation date. (RFC 3339 format)

updated_at

string | null · date-time

Gateway last modification date. (RFC 3339 format)

type

string

Gateway type name (commercial offer).

bandwidth

integer · uint64

Bandwidth available of the gateway.

status

Current status of the gateway.

Enum values:

unknown_status

stopped

allocating

configuring

running

stopping

failed

deleting

Default: unknown_status

name

string

Name of the gateway.

tags

string[]

Tags associated with the gateway.

Public IPv4 address of the gateway.

GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network).

version

string | null

Version of the running gateway software.

can_upgrade_to

string | null

Newly available gateway software version that can be updated to.

bastion_enabled

boolean

Defines whether SSH bastion is enabled on the gateway.

bastion_port

integer · uint32

Port of the SSH bastion.

smtp_enabled

boolean

Defines whether SMTP traffic is allowed to pass through the gateway.

is_legacy

boolean

Defines whether the gateway uses non-IPAM IP configurations.

bastion_allowed_ips

string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

zone

string

Zone of the gateway.

POST/vpc-gw/v2/zones/{zone}/gateways

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enable_bastion": false,
    "enable_smtp": false,
    "name": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "type": "string"
  }' \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/gateways"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "type": "type",
  "ip_id": "6170692e-7363-616c-6577-61792e636f6d",
  "enable_smtp": true,
  "enable_bastion": true,
  "bastion_port": 0
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "type": "type",
  "bandwidth": 0,
  "status": "unknown_status",
  "name": "name",
  "tags": [
    "string"
  ],
  "ipv4": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "srn": "srn",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "reverse",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "zone"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "mac_address",
      "masquerade_enabled": true,
      "status": "unknown_status",
      "push_default_route": true,
      "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d",
      "zone": "zone"
    }
  ],
  "version": "version",
  "can_upgrade_to": "can_upgrade_to",
  "bastion_enabled": true,
  "bastion_port": 0,
  "smtp_enabled": true,
  "is_legacy": true,
  "bastion_allowed_ips": [
    "1.2.3.4/32"
  ],
  "zone": "zone"
}

json

application/json

Get a Public Gateway

GET

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}

Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its name, type, status and more.

Get a Public Gateway › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_id

string · required

ID of the gateway to fetch. (UUID format)

Get a Public Gateway › Responses

200

id

string

ID of the gateway. (UUID format)

srn

string

The SRN of the gateway.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

Gateway creation date. (RFC 3339 format)

updated_at

string | null · date-time

Gateway last modification date. (RFC 3339 format)

type

string

Gateway type name (commercial offer).

bandwidth

integer · uint64

Bandwidth available of the gateway.

status

Current status of the gateway.

Enum values:

unknown_status

stopped

allocating

configuring

running

stopping

failed

deleting

Default: unknown_status

name

string

Name of the gateway.

tags

string[]

Tags associated with the gateway.

Public IPv4 address of the gateway.

GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network).

version

string | null

Version of the running gateway software.

can_upgrade_to

string | null

Newly available gateway software version that can be updated to.

bastion_enabled

boolean

Defines whether SSH bastion is enabled on the gateway.

bastion_port

integer · uint32

Port of the SSH bastion.

smtp_enabled

boolean

Defines whether SMTP traffic is allowed to pass through the gateway.

is_legacy

boolean

Defines whether the gateway uses non-IPAM IP configurations.

bastion_allowed_ips

string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

zone

string

Zone of the gateway.

GET/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "type": "type",
  "bandwidth": 0,
  "status": "unknown_status",
  "name": "name",
  "tags": [
    "string"
  ],
  "ipv4": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "srn": "srn",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "reverse",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "zone"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "mac_address",
      "masquerade_enabled": true,
      "status": "unknown_status",
      "push_default_route": true,
      "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d",
      "zone": "zone"
    }
  ],
  "version": "version",
  "can_upgrade_to": "can_upgrade_to",
  "bastion_enabled": true,
  "bastion_port": 0,
  "smtp_enabled": true,
  "is_legacy": true,
  "bastion_allowed_ips": [
    "1.2.3.4/32"
  ],
  "zone": "zone"
}

json

application/json

Delete a Public Gateway

DELETE

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}

Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible.

Delete a Public Gateway › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_id

string · required

ID of the gateway to delete. (UUID format)

Delete a Public Gateway › query Parameters

delete_ip

boolean · required

Defines whether the PGW's IP should be deleted.

Delete a Public Gateway › Responses

200

id

string

ID of the gateway. (UUID format)

srn

string

The SRN of the gateway.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

Gateway creation date. (RFC 3339 format)

updated_at

string | null · date-time

Gateway last modification date. (RFC 3339 format)

type

string

Gateway type name (commercial offer).

bandwidth

integer · uint64

Bandwidth available of the gateway.

status

Current status of the gateway.

Enum values:

unknown_status

stopped

allocating

configuring

running

stopping

failed

deleting

Default: unknown_status

name

string

Name of the gateway.

tags

string[]

Tags associated with the gateway.

Public IPv4 address of the gateway.

GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network).

version

string | null

Version of the running gateway software.

can_upgrade_to

string | null

Newly available gateway software version that can be updated to.

bastion_enabled

boolean

Defines whether SSH bastion is enabled on the gateway.

bastion_port

integer · uint32

Port of the SSH bastion.

smtp_enabled

boolean

Defines whether SMTP traffic is allowed to pass through the gateway.

is_legacy

boolean

Defines whether the gateway uses non-IPAM IP configurations.

bastion_allowed_ips

string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

zone

string

Zone of the gateway.

DELETE/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}?delete_ip=false"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "type": "type",
  "bandwidth": 0,
  "status": "unknown_status",
  "name": "name",
  "tags": [
    "string"
  ],
  "ipv4": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "srn": "srn",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "reverse",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "zone"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "mac_address",
      "masquerade_enabled": true,
      "status": "unknown_status",
      "push_default_route": true,
      "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d",
      "zone": "zone"
    }
  ],
  "version": "version",
  "can_upgrade_to": "can_upgrade_to",
  "bastion_enabled": true,
  "bastion_port": 0,
  "smtp_enabled": true,
  "is_legacy": true,
  "bastion_allowed_ips": [
    "1.2.3.4/32"
  ],
  "zone": "zone"
}

json

application/json

Update a Public Gateway

PATCH

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}

Update the parameters of an existing Public Gateway, for example, its name, tags, SSH bastion configuration, and DNS servers.

Update a Public Gateway › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_id

string · required

ID of the gateway to update. (UUID format)

Update a Public Gateway › Request Body

name

string | null

Name for the gateway.

tags

array | null

Tags for the gateway.

enable_bastion

boolean | null

Defines whether SSH bastion should be enabled the gateway.

bastion_port

integer | null · uint32

Port of the SSH bastion.

enable_smtp

boolean | null

Defines whether SMTP traffic should be allowed to pass through the gateway.

Update a Public Gateway › Responses

200

id

string

ID of the gateway. (UUID format)

srn

string

The SRN of the gateway.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

Gateway creation date. (RFC 3339 format)

updated_at

string | null · date-time

Gateway last modification date. (RFC 3339 format)

type

string

Gateway type name (commercial offer).

bandwidth

integer · uint64

Bandwidth available of the gateway.

status

Current status of the gateway.

Enum values:

unknown_status

stopped

allocating

configuring

running

stopping

failed

deleting

Default: unknown_status

name

string

Name of the gateway.

tags

string[]

Tags associated with the gateway.

Public IPv4 address of the gateway.

GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network).

version

string | null

Version of the running gateway software.

can_upgrade_to

string | null

Newly available gateway software version that can be updated to.

bastion_enabled

boolean

Defines whether SSH bastion is enabled on the gateway.

bastion_port

integer · uint32

Port of the SSH bastion.

smtp_enabled

boolean

Defines whether SMTP traffic is allowed to pass through the gateway.

is_legacy

boolean

Defines whether the gateway uses non-IPAM IP configurations.

bastion_allowed_ips

string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

zone

string

Zone of the gateway.

PATCH/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}"

Example Request Body

{
  "name": "name",
  "tags": [],
  "enable_bastion": true,
  "bastion_port": 0,
  "enable_smtp": true
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "type": "type",
  "bandwidth": 0,
  "status": "unknown_status",
  "name": "name",
  "tags": [
    "string"
  ],
  "ipv4": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "srn": "srn",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "reverse",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "zone"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "mac_address",
      "masquerade_enabled": true,
      "status": "unknown_status",
      "push_default_route": true,
      "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d",
      "zone": "zone"
    }
  ],
  "version": "version",
  "can_upgrade_to": "can_upgrade_to",
  "bastion_enabled": true,
  "bastion_port": 0,
  "smtp_enabled": true,
  "is_legacy": true,
  "bastion_allowed_ips": [
    "1.2.3.4/32"
  ],
  "zone": "zone"
}

json

application/json

Refresh a Public Gateway's SSH keys

POST

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}/refresh-ssh-keys

Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself.

Refresh a Public Gateway's SSH keys › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_id

string · required

ID of the gateway to refresh SSH keys on. (UUID format)

Refresh a Public Gateway's SSH keys › Request Body

Refresh a Public Gateway's SSH keys › Responses

200

id

string

ID of the gateway. (UUID format)

srn

string

The SRN of the gateway.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

Gateway creation date. (RFC 3339 format)

updated_at

string | null · date-time

Gateway last modification date. (RFC 3339 format)

type

string

Gateway type name (commercial offer).

bandwidth

integer · uint64

Bandwidth available of the gateway.

status

Current status of the gateway.

Enum values:

unknown_status

stopped

allocating

configuring

running

stopping

failed

deleting

Default: unknown_status

name

string

Name of the gateway.

tags

string[]

Tags associated with the gateway.

Public IPv4 address of the gateway.

GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network).

version

string | null

Version of the running gateway software.

can_upgrade_to

string | null

Newly available gateway software version that can be updated to.

bastion_enabled

boolean

Defines whether SSH bastion is enabled on the gateway.

bastion_port

integer · uint32

Port of the SSH bastion.

smtp_enabled

boolean

Defines whether SMTP traffic is allowed to pass through the gateway.

is_legacy

boolean

Defines whether the gateway uses non-IPAM IP configurations.

bastion_allowed_ips

string[]

Ranges of IP addresses allowed to connect to the gateway's SSH bastion. (IP network)

zone

string

Zone of the gateway.

POST/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}/refresh-ssh-keys

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}/refresh-ssh-keys"

Example Request Body

{}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "srn": "srn",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "type": "type",
  "bandwidth": 0,
  "status": "unknown_status",
  "name": "name",
  "tags": [
    "string"
  ],
  "ipv4": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "srn": "srn",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "reverse",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "zone"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "srn": "srn",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "mac_address",
      "masquerade_enabled": true,
      "status": "unknown_status",
      "push_default_route": true,
      "ipam_ip_id": "6170692e-7363-616c-6577-61792e636f6d",
      "zone": "zone"
    }
  ],
  "version": "version",
  "can_upgrade_to": "can_upgrade_to",
  "bastion_enabled": true,
  "bastion_port": 0,
  "smtp_enabled": true,
  "is_legacy": true,
  "bastion_allowed_ips": [
    "1.2.3.4/32"
  ],
  "zone": "zone"
}

json

application/json

Upgrade a Public Gateway to the latest version and/or to a different commercial offer type

POST

https://api.scaleway.com

/vpc-gw/v2/zones/{zone}/gateways/{gateway_id}/upgrade

Upgrade a given Public Gateway to the newest software version or to a different commercial offer type. This applies the latest bugfixes and features to your Public Gateway. Note that gateway service will be interrupted during the update.

Upgrade a Public Gateway to the latest version and/or to a different commercial offer type › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

it-mil-1

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

gateway_id

string · required

ID of the gateway to upgrade. (UUID format)

Upgrade a Public Gateway to the latest version and/or to a different commercial offer type › Request Body

type

string | null

Gateway type (commercial offer).

Upgrade a Public Gateway to the latest version and/or to a different commercial offer type › Responses

200

id

string

ID of the gateway. (UUID format)

srn

string

The SRN of the gateway.

organization_id

string

Owning Organization. (UUID format)

project_id

string

Owning Project. (UUID format)

created_at

string | null · date-time

Gateway creation date. (RFC 3339 format)

updated_at

string | null · date-time

Gateway last modification date. (RFC 3339 format)

type

string

Gateway type name (commercial offer).

bandwidth

integer · uint64

Bandwidth available of the gateway.

status

Current status of the gateway.

Enum values:

unknown_status

stopped

allocating

configuring

running

stopping

failed

deleting

Default: unknown_status

name

string

Name of the gateway.

tags

string[]

Tags associated with the gateway.

Public IPv4 address of the gateway.