Object Storage private access

Download schema

Object Storage private access enables resources connected to selected Private Networks to access Scaleway Object Storage over a private network, without traversing the public Internet.

Disable Object Storage private access

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/disable

Disable Object Storage private access for a VPC.

Disable Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC for which to disable Object Storage private access. (UUID format)

Disable Object Storage private access › Responses

200

scaleway.vpc.v2.VPC

id

string

VPC ID. (UUID format)

name

string

VPC name.

organization_id

string

Scaleway Organization the VPC belongs to. (UUID format)

project_id

string

Scaleway Project the VPC belongs to. (UUID format)

region

string

Region of the VPC.

tags

string[]

Tags for the VPC.

is_default

boolean

Defines whether the VPC is the default one for its Project.

created_at

string | null · date-time

Date the VPC was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the VPC was last modified. (RFC 3339 format)

private_network_count

integer · uint32

Number of Private Networks within this VPC.

routing_enabled

boolean

Defines whether the VPC routes traffic between its Private Networks.

custom_routes_propagation_enabled

boolean

Defines whether the VPC advertises custom routes between its Private Networks.

transitivity_enabled

boolean

Defines whether the VPC allows packets from peered VPCs to transit through.

object_storage_private_access_enabled

boolean

Defines whether the Object Storage private access is enabled for the VPC.

POST/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/disable

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/disable"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region",
  "tags": [
    "string"
  ],
  "is_default": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_count": 0,
  "routing_enabled": true,
  "custom_routes_propagation_enabled": true,
  "transitivity_enabled": true,
  "object_storage_private_access_enabled": true
}

json

application/json

Enable Object Storage private access

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/enable

Enable Object Storage private access for a VPC.

Enable Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC for which to enable Object Storage private access. (UUID format)

Enable Object Storage private access › query Parameters

private_network_ids

string[]

IDs of the Private Networks for which to enable Object Storage private access.

Enable Object Storage private access › Responses

200

scaleway.vpc.v2.VPC

id

string

VPC ID. (UUID format)

name

string

VPC name.

organization_id

string

Scaleway Organization the VPC belongs to. (UUID format)

project_id

string

Scaleway Project the VPC belongs to. (UUID format)

region

string

Region of the VPC.

tags

string[]

Tags for the VPC.

is_default

boolean

Defines whether the VPC is the default one for its Project.

created_at

string | null · date-time

Date the VPC was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the VPC was last modified. (RFC 3339 format)

private_network_count

integer · uint32

Number of Private Networks within this VPC.

routing_enabled

boolean

Defines whether the VPC routes traffic between its Private Networks.

custom_routes_propagation_enabled

boolean

Defines whether the VPC advertises custom routes between its Private Networks.

transitivity_enabled

boolean

Defines whether the VPC allows packets from peered VPCs to transit through.

object_storage_private_access_enabled

boolean

Defines whether the Object Storage private access is enabled for the VPC.

POST/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/enable

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/enable"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region",
  "tags": [
    "string"
  ],
  "is_default": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_count": 0,
  "routing_enabled": true,
  "custom_routes_propagation_enabled": true,
  "transitivity_enabled": true,
  "object_storage_private_access_enabled": true
}

json

application/json

Set Object Storage private access Private Networks

PUT

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/private-networks

Set the Private Networks associated with the Object Storage private access to enable Object Storage integration for their resources.

Set Object Storage private access Private Networks › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC containing the Object Storage private access. (UUID format)

Set Object Storage private access Private Networks › Request Body

private_network_ids

string[] · required

IDs of the Private Networks to associate with the Object Storage private access.

Set Object Storage private access Private Networks › Responses

200

scaleway.vpc.v2.SetPrivateNetworksObjectStoragePrivateAccessResponse

vpc_id

string

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_ids

string[]

IDs of the Private Networks associated with the Object Storage private access.

Add a Private Network to an Object Storage private access

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/private-networks

Add a Private Network to the Object Storage private access to enable Object Storage integration for its resources.

Add a Private Network to an Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC containing the Object Storage private access. (UUID format)

Add a Private Network to an Object Storage private access › Request Body

private_network_id

string · required

ID of the Private Network to add to the Object Storage private access. (UUID format)

Add a Private Network to an Object Storage private access › Responses

200

scaleway.vpc.v2.AddPrivateNetworkObjectStoragePrivateAccessResponse

vpc_id

string

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_ids

string[]

IDs of the Private Networks associated with the Object Storage private access.

Remove a Private Network from an Object Storage private access

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/private-networks/{private_network_id}

Remove a Private Network from the Object Storage private access to disable Object Storage integration for its resources.

Remove a Private Network from an Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_id

string · required

ID of the Private Network to remove from the Object Storage private access. (UUID format)

Remove a Private Network from an Object Storage private access › Responses

No data returned

Ingress Rules

Disable Object Storage private access

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/disable

Disable Object Storage private access for a VPC.

Disable Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC for which to disable Object Storage private access. (UUID format)

Disable Object Storage private access › Responses

200

scaleway.vpc.v2.VPC

id

string

VPC ID. (UUID format)

name

string

VPC name.

organization_id

string

Scaleway Organization the VPC belongs to. (UUID format)

project_id

string

Scaleway Project the VPC belongs to. (UUID format)

region

string

Region of the VPC.

tags

string[]

Tags for the VPC.

is_default

boolean

Defines whether the VPC is the default one for its Project.

created_at

string | null · date-time

Date the VPC was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the VPC was last modified. (RFC 3339 format)

private_network_count

integer · uint32

Number of Private Networks within this VPC.

routing_enabled

boolean

Defines whether the VPC routes traffic between its Private Networks.

custom_routes_propagation_enabled

boolean

Defines whether the VPC advertises custom routes between its Private Networks.

transitivity_enabled

boolean

Defines whether the VPC allows packets from peered VPCs to transit through.

object_storage_private_access_enabled

boolean

Defines whether the Object Storage private access is enabled for the VPC.

Enable Object Storage private access

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/enable

Enable Object Storage private access for a VPC.

Enable Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC for which to enable Object Storage private access. (UUID format)

Enable Object Storage private access › query Parameters

private_network_ids

string[]

IDs of the Private Networks for which to enable Object Storage private access.

Enable Object Storage private access › Responses

200

scaleway.vpc.v2.VPC

id

string

VPC ID. (UUID format)

name

string

VPC name.

organization_id

string

Scaleway Organization the VPC belongs to. (UUID format)

project_id

string

Scaleway Project the VPC belongs to. (UUID format)

region

string

Region of the VPC.

tags

string[]

Tags for the VPC.

is_default

boolean

Defines whether the VPC is the default one for its Project.

created_at

string | null · date-time

Date the VPC was created. (RFC 3339 format)

updated_at

string | null · date-time

Date the VPC was last modified. (RFC 3339 format)

private_network_count

integer · uint32

Number of Private Networks within this VPC.

routing_enabled

boolean

Defines whether the VPC routes traffic between its Private Networks.

custom_routes_propagation_enabled

boolean

Defines whether the VPC advertises custom routes between its Private Networks.

transitivity_enabled

boolean

Defines whether the VPC allows packets from peered VPCs to transit through.

object_storage_private_access_enabled

boolean

Defines whether the Object Storage private access is enabled for the VPC.

Set Object Storage private access Private Networks

PUT

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/private-networks

Set the Private Networks associated with the Object Storage private access to enable Object Storage integration for their resources.

Set Object Storage private access Private Networks › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC containing the Object Storage private access. (UUID format)

Set Object Storage private access Private Networks › Request Body

private_network_ids

string[] · required

IDs of the Private Networks to associate with the Object Storage private access.

Set Object Storage private access Private Networks › Responses

200

scaleway.vpc.v2.SetPrivateNetworksObjectStoragePrivateAccessResponse

vpc_id

string

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_ids

string[]

IDs of the Private Networks associated with the Object Storage private access.

Add a Private Network to an Object Storage private access

POST

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/private-networks

Add a Private Network to the Object Storage private access to enable Object Storage integration for its resources.

Add a Private Network to an Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC containing the Object Storage private access. (UUID format)

Add a Private Network to an Object Storage private access › Request Body

private_network_id

string · required

ID of the Private Network to add to the Object Storage private access. (UUID format)

Add a Private Network to an Object Storage private access › Responses

200

scaleway.vpc.v2.AddPrivateNetworkObjectStoragePrivateAccessResponse

vpc_id

string

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_ids

string[]

IDs of the Private Networks associated with the Object Storage private access.

Remove a Private Network from an Object Storage private access

DELETE

https://api.scaleway.com

/vpc/v2/regions/{region}/object-storage-private-access/{vpc_id}/private-networks/{private_network_id}

Remove a Private Network from the Object Storage private access to disable Object Storage integration for its resources.

Remove a Private Network from an Object Storage private access › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

it-mil

nl-ams

pl-waw

vpc_id

string · required

ID of the VPC containing the Object Storage private access. (UUID format)

private_network_id

string · required

ID of the Private Network to remove from the Object Storage private access. (UUID format)

Remove a Private Network from an Object Storage private access › Responses

No data returned