Private Networks

Download schema

The Private Network object. It represents Scaleway Private Networks which can be attached to/detached from a Load Balancer. Use this endpoint to list the Private Networks attached to a Load Balancer, and to attach/detach a Load Balancer to/from a Private Network. To create new Private Networks, use the dedicated Private Networks APIOpen in new context.

Attach a Load Balancer to a Private Network

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/attach-private-network

Attach a specified Load Balancer to a specified Private Network, defining a static or DHCP configuration for the Load Balancer on the network.

Attach a Load Balancer to a Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID.

Attach a Load Balancer to a Private Network › Request Body

private_network_id

string · required

Private Network ID.

ipam_ids

string[]

IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network. In the future, it will be possible to specify multiple IPs in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is expected. When null, a new private IP address is created for the Load Balancer on this Private Network. (UUID format)

Attach a Load Balancer to a Private Network › Responses

200

scaleway.lb.v1.PrivateNetwork

scaleway.lb.v1.Lb

Load Balancer object which is attached to the Private Network.

ipam_ids

string[]

IPAM IDs of the booked IP addresses. (UUID format)

private_network_id

string

Private Network ID.

status

scaleway.lb.v1.PrivateNetwork.Status · enum

Status of Private Network connection.

Enum values:

unknown

ready

pending

error

Default: unknown

created_at

string | null · date-time

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

updated_at

string | null · date-time

Date on which the PN was last updated. (RFC 3339 format)

POST/lb/v1/zones/{zone}/lbs/{lb_id}/attach-private-network

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"private_network_id":"string"}' \
  "https://api.scaleway.com/lb/v1/zones/{zone}/lbs/{lb_id}/attach-private-network"

Example Request Body

{
  "private_network_id": "private_network_id",
  "ipam_ids": [
    "6170692e-7363-616c-6577-61792e636f6d"
  ]
}

json

Example Responses

{
  "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"
  },
  "ipam_ids": [
    "6170692e-7363-616c-6577-61792e636f6d"
  ],
  "static_config": {
    "ip_address": [
      "string"
    ]
  },
  "dhcp_config": {
    "ip_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "private_network_id": "private_network_id",
  "status": "unknown",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z"
}

json

application/json

Detach Load Balancer from Private Network

POST

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/detach-private-network

Detach a specified Load Balancer from a specified Private Network.

Detach Load Balancer from Private Network › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load balancer ID.

Detach Load Balancer from Private Network › Request Body

private_network_id

string · required

Set your instance private network id.

Detach Load Balancer from Private Network › Responses

No data returned

List Private Networks attached to a Load Balancer

GET

https://api.scaleway.com

/lb/v1/zones/{zone}/lbs/{lb_id}/private-networks

List the Private Networks attached to a given Load Balancer, specified by its Load Balancer ID. The response is an array of Private Network objects, giving information including the status, configuration, name and creation date of each Private Network.

List Private Networks attached to a Load Balancer › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

pl-waw-3

lb_id

string · required

Load Balancer ID.

List Private Networks attached to a Load Balancer › query Parameters

order_by

scaleway.lb.v1.ListPrivateNetworksRequest.OrderBy · enum

Sort order of Private Network objects in the response.

Enum values:

created_at_asc

created_at_desc

Default: created_at_asc

page_size

integer · uint32

Number of objects to return.

page

integer · int32

The page number to return, from the paginated results.

List Private Networks attached to a Load Balancer › Responses

200

scaleway.lb.v1.ListLbPrivateNetworksResponse

scaleway.lb.v1.PrivateNetwork[]

List of Private Network objects attached to the Load Balancer.

total_count

integer · uint32

Total number of objects in the response.

GET/lb/v1/zones/{zone}/lbs/{lb_id}/private-networks

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

Example Responses

{
  "private_network": [
    {
      "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"
      },
      "ipam_ids": [
        "6170692e-7363-616c-6577-61792e636f6d"
      ],
      "static_config": {
        "ip_address": [
          "string"
        ]
      },
      "dhcp_config": {
        "ip_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "private_network_id": "private_network_id",
      "status": "unknown",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z"
    }
  ],
  "total_count": 0
}

json

application/json

Alert Subscribers