DigitalOcean.SSHKey (digital_ocean v0.5.0)

Summary

Functions

create(opts)

Create an SSH key.

delete(key_id)

Delete an SSH key.

get(key_id)

Retrieve an existing SSH key.

list(opts \\ [])

Retrieve a list of SSH keys.

update(key_id, opts \\ [])

Update the name of an SSH key.

Functions

create(opts)

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

Create an SSH key.

Examples

iex> DigitalOcean.SSHKey.create(
...>   name: "my ssh public key",
...>   public_key: "ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example",
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

delete(key_id)

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

Delete an SSH key.

Examples

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

get(key_id)

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

Retrieve an existing SSH key.

Examples

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

list(opts \\ [])

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

Retrieve a list of SSH keys.

Examples

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

update(key_id, opts \\ [])

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

Update the name of an SSH key.

Examples

iex> DigitalOcean.SSHKey.update(
...>   512190,
...>   name: "New Name For SSH Public Key"
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }