DigitalOcean.FloatingIP (digital_ocean v0.5.0)

Summary

Functions

Create a floating IP.

Delete a floating IP.

Retrieve a floating IP.

Retrieve a list of floating IP's.

Functions

create(opts)

@spec create(Keyword.t()) :: DigitalOcean.Operation.t()

Create a floating IP.

Example creating a floating IP for a droplet

iex> DigitalOcean.FloatingIP.create(droplet_id: 123456) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

Example create a floating IP reserved for a region

iex> DigitalOcean.FloatingIP.create(region: "nyc3") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

delete(ip_addr)

@spec delete(String.t()) :: DigitalOcean.Operation.t()

Delete a floating IP.

Examples

iex> DigitalOcean.FloatingIP.delete("45.55.96.47") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

get(ip_addr)

Retrieve a floating IP.

Examples

iex> DigitalOcean.FloatingIP.get("45.55.96.47") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

list(opts \\ [])

@spec list(Keyword.t()) :: DigitalOcean.Operation.t()

Retrieve a list of floating IP's.

Examples

iex> DigitalOcean.FloatingIP.list() |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }