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

Create a custom image.

Examples

iex> DigitalOcean.Image.create(
...>   name: "ubuntu-18.04-minimal",
...>   url: "http://cloud-images.ubuntu.com/minimal/releases/bionic/release/ubuntu-18.04-minimal-cloudimg-amd64.img",
...>   distribution: "ubuntu",
...>   region: "nyc3",
...>   description: "Cloud-optimized image w/ small footprint",
...>   tags: ["base-image", "prod"]
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

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

Delete an image.

Examples

iex> DigitalOcean.Image.delete(7938391) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

@spec get(String.t() | integer()) :: DigitalOcean.Operation.t()

Retrieve an image by id or slug.

Example retrieving an image by id

iex> DigitalOcean.Image.get(7555620) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

Example retrieving an image by slug

iex> DigitalOcean.Image.get("ubuntu-16-04-x64") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

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

Retrieve a list of images.

Example retrieving all images

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

Example retrieving distribution images

iex> DigitalOcean.Image.list(type: "distribution") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

See the official DigitalOcean v2 API documentation for all options listing images.

@spec update(DigitalOcean.id_t(), Keyword.t()) :: DigitalOcean.Operation.t()

Update an image.

Examples

iex> DigitalOcean.Image.update("7938391", name: "new-image-name") |> DigitalOcean.request()
{ :ok, DigitalOcean.Response{} }