Scaleway logo
Elastic Metal - Flexible IP API
Elastic Metal - Flexible IP API

Schemas

Download schema

scaleway.flexible_ip.v1alpha1.AttachFlexibleIPsResponse

total_count
​integer · uint32

Total count of flexible IPs that are being updated.

List of flexible IPs in an updating state.

scaleway.flexible_ip.v1alpha1.DetachFlexibleIPsResponse

total_count
​integer · uint32

Total count of flexible IPs that are being detached.

List of flexible IPs in a detaching state.

scaleway.flexible_ip.v1alpha1.FlexibleIP

id
​string

ID of the flexible IP.

organization_id
​string

ID of the Organization the flexible IP is attached to.

project_id
​string

ID of the Project the flexible IP is attached to.

description
​string

Flexible IP description.

tags
​string[]

Flexible IP tags.

updated_at
​string | null · date-time

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

created_at
​string | null · date-time

Date on which the flexible IP was created. (RFC 3339 format)

Flexible IP status.

  • ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
  • updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
  • attached: flexible IP is attached to a server
  • error: a flexible IP operation resulted in an error
  • detaching: flexible IP is being detached from a server
  • locked: the resource of the flexible IP is locked.
Enum values:
unknown
ready
updating
attached
error
detaching
locked
Default: unknown
ip_address
​string

IP of the flexible IP. (IP network)

MAC address of the flexible IP.

server_id
​string | null

ID of the server linked to the flexible IP.

reverse
​string

Reverse DNS value.

zone
​string

Availability Zone of the flexible IP.

srn
​string · pattern: ^srn://flexible-ip\.…

The SRN of the flexible ip.

scaleway.flexible_ip.v1alpha1.FlexibleIP.Status

string · enum
Enum values:
unknown
ready
updating
attached
error
detaching
locked
Default: unknown

scaleway.flexible_ip.v1alpha1.ListFlexibleIPsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
Default: created_at_asc

scaleway.flexible_ip.v1alpha1.ListFlexibleIPsResponse

total_count
​integer · uint32

Total count of matching flexible IPs.

List of all flexible IPs.

scaleway.flexible_ip.v1alpha1.MACAddress

id
​string

ID of the flexible IP.

mac_address
​string

MAC address of the Virtual MAC.

Type of virtual MAC.

Enum values:
unknown_type
vmware
xen
kvm
Default: unknown_type

Status of virtual MAC.

Enum values:
unknown
ready
updating
used
error
deleting
Default: unknown
updated_at
​string | null · date-time

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

created_at
​string | null · date-time

Date on which the virtual MAC was created. (RFC 3339 format)

zone
​string

MAC address IP Availability Zone.

scaleway.flexible_ip.v1alpha1.MACAddress.Status

string · enum
Enum values:
unknown
ready
updating
used
error
deleting
Default: unknown

scaleway.flexible_ip.v1alpha1.MACAddress.Type

string · enum
Enum values:
unknown_type
vmware
xen
kvm
Default: unknown_type