mirror of
https://github.com/avitex/elixir-vultr
synced 2024-12-05 00:59:56 +00:00
36 lines
887 B
Markdown
36 lines
887 B
Markdown
[](https://travis-ci.com/avitex/elixir-vultr)
|
|
[](https://hex.pm/packages/vultr)
|
|
[](https://hexdocs.pm/vultr)
|
|
|
|
# Vultr
|
|
|
|
**Simple wrapper for the [Vultr API](https://www.vultr.com/api/).**
|
|
Documentation hosted on [hexdocs](https://hexdocs.pm/vultr).
|
|
|
|
## Installation
|
|
|
|
Add `vultr` to your list of dependencies in `mix.exs`:
|
|
|
|
```elixir
|
|
def deps do
|
|
[{:vultr, "~> 0.3.0"}]
|
|
end
|
|
```
|
|
|
|
## Examples
|
|
#### Retrieving app list
|
|
|
|
```elixir
|
|
Vultr.app_list()
|
|
|
|
# Example response
|
|
{:ok, %{ "1" => %{"APPID" => "1", "deploy_name" => "LEMP on CentOS 6 x64", ... }, ... }}
|
|
```
|
|
|
|
#### Using authenticated methods
|
|
|
|
```elixir
|
|
client = Vultr.client("<APIKEY>")
|
|
Vultr.server_list(client, [])
|
|
```
|