FlexibleIpApi.md

\FlexibleIpApi

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

Method	HTTP request	Description
attach_flexible_ip	POST /flexible-ip/v1alpha1/zones/{zone}/fips/attach	Attach a Flexible IP to a server
create_flexible_ip	POST /flexible-ip/v1alpha1/zones/{zone}/fips	Create a Flexible IP
delete_flexible_ip	DELETE /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}	Delete a Flexible IP
delete_mac_addr	DELETE /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac	Remove a virtual MAC from a Flexible IP
detach_flexible_ip	POST /flexible-ip/v1alpha1/zones/{zone}/fips/detach	Detach a Flexible IP from a server
duplicate_mac_addr	POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/duplicate	Duplicate a Virtual MAC
generate_mac_addr	POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac	Generate a virtual MAC on a given Flexible IP
get_flexible_ip	GET /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}	Get a Flexible IP
list_flexible_ips	GET /flexible-ip/v1alpha1/zones/{zone}/fips	List Flexible IPs
update_flexible_ip	PATCH /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}	Update a Flexible IP

attach_flexible_ip

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodAttachFlexibleIpsResponse attach_flexible_ip(zone, attach_flexible_ip_request) Attach a Flexible IP to a server

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
attach_flexible_ip_request	AttachFlexibleIpRequest		[required]

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodAttachFlexibleIpsResponse

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]

create_flexible_ip

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp create_flexible_ip(zone, create_flexible_ip_request) Create a Flexible IP

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
create_flexible_ip_request	CreateFlexibleIpRequest		[required]

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp

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_flexible_ip

delete_flexible_ip(zone, fip_id) Delete a Flexible IP

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
fip_id	String	ID of the Flexible IP to delete	[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]

delete_mac_addr

delete_mac_addr(zone, fip_id) Remove a virtual MAC from a Flexible IP

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
fip_id	String	If the Flexible IP belongs to a MAC group, the MAC will be removed from the MAC group and from the Flexible IP.	[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]

detach_flexible_ip

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodDetachFlexibleIpsResponse detach_flexible_ip(zone, detach_flexible_ip_request) Detach a Flexible IP from a server

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
detach_flexible_ip_request	DetachFlexibleIpRequest		[required]

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodDetachFlexibleIpsResponse

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]

duplicate_mac_addr

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp duplicate_mac_addr(zone, fip_id, duplicate_mac_addr_request) Duplicate a Virtual MAC

Duplicate a Virtual MAC from a given Flexible IP onto another attached on the same server.

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
fip_id	String	Flexible IPs need to be attached to the same server.	[required]
duplicate_mac_addr_request	DuplicateMacAddrRequest		[required]

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp

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]

generate_mac_addr

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp generate_mac_addr(zone, fip_id, generate_mac_addr_request) Generate a virtual MAC on a given Flexible IP

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
fip_id	String	Flexible IP ID on which to generate a Virtual MAC	[required]
generate_mac_addr_request	GenerateMacAddrRequest		[required]

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp

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]

get_flexible_ip

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp get_flexible_ip(zone, fip_id) Get a Flexible IP

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
fip_id	String	Flexible IP ID	[required]

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp

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_flexible_ips

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodListFlexibleIpsResponse list_flexible_ips(zone, order_by, page, page_size, tags, status, server_ids, organization_id, project_id) List Flexible IPs

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 Flexible IPs		[default to created_at_asc]
page	Option<i32>	The page number for the returned Flexible IPs		[default to 1]
page_size	Option<i32>	The maximum number of Flexible IPs per page		[default to 20]
tags	Option<Vec>	Filter Flexible IPs with one or more matching tags
status	Option<Veccrate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIpPeriodStatus>	Filter Flexible IPs by status
server_ids	Option<Vec>	Filter Flexible IPs by server IDs
organization_id	Option<String>	Filter Flexible IPs by organization ID
project_id	Option<String>	Filter Flexible IPs by project ID

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodListFlexibleIpsResponse

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_flexible_ip

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp update_flexible_ip(zone, fip_id, update_flexible_ip_request) Update a Flexible IP

Parameters

Name	Type	Description	Required	Notes
zone	String	The zone you want to target	[required]
fip_id	String	ID of the Flexible IP to update	[required]
update_flexible_ip_request	UpdateFlexibleIpRequest		[required]

Return type

crate::models::ScalewayPeriodFlexibleIpPeriodV1alpha1PeriodFlexibleIp

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]