Skip to content

Latest commit

 

History

History
166 lines (97 loc) · 6.29 KB

PrivateNetworksApi.md

File metadata and controls

166 lines (97 loc) · 6.29 KB

\PrivateNetworksApi

All URIs are relative to https://api.scaleway.com

Method HTTP request Description
create_private_network POST /vpc/v1/zones/{zone}/private-networks Create a private network
delete_private_network DELETE /vpc/v1/zones/{zone}/private-networks/{private_network_id} Delete a private network
get_private_network GET /vpc/v1/zones/{zone}/private-networks/{private_network_id} Get a private network
list_private_networks GET /vpc/v1/zones/{zone}/private-networks List private networks
update_private_network PATCH /vpc/v1/zones/{zone}/private-networks/{private_network_id} Update private network

create_private_network

crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork create_private_network(zone, create_private_network_request) Create a private network

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
create_private_network_request CreatePrivateNetworkRequest [required]

Return type

crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork

Authorization

scaleway

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_private_network

delete_private_network(zone, private_network_id) Delete a private network

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
private_network_id String The private network ID [required]

Return type

(empty response body)

Authorization

scaleway

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_private_network

crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork get_private_network(zone, private_network_id) Get a private network

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
private_network_id String The private network id [required]

Return type

crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork

Authorization

scaleway

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_private_networks

crate::models::ScalewayPeriodVpcPeriodV1PeriodListPrivateNetworksResponse list_private_networks(zone, order_by, page, page_size, name, tags, organization_id, project_id, private_network_ids) List private networks

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
order_by Option<String> The sort order of the returned private networks [default to created_at_asc]
page Option<i32> The page number for the returned private networks [default to 1]
page_size Option<i32> The maximum number of private networks per page [default to 20]
name Option<String> Filter private networks with names containing this string
tags Option<Vec> Filter private networks with one or more matching tags
organization_id Option<String> The organization ID on which to filter the returned private networks
project_id Option<String> The project ID on which to filter the returned private networks
private_network_ids Option<Vec> The PrivateNetwork IDs on which to filter the returned private networks (UUID format)

Return type

crate::models::ScalewayPeriodVpcPeriodV1PeriodListPrivateNetworksResponse

Authorization

scaleway

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_private_network

crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork update_private_network(zone, private_network_id, update_private_network_request) Update private network

Parameters

Name Type Description Required Notes
zone String The zone you want to target [required]
private_network_id String The private network ID [required]
update_private_network_request UpdatePrivateNetworkRequest [required]

Return type

crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork

Authorization

scaleway

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]