# ex_incus v1.0.0 - Table of Contents

> Elixir client for the Incus (linuxcontainers.org) REST API

## Pages

- [ExIncus](readme.md)

## Modules

- [ExIncus](ExIncus.md): Elixir client for the [Incus](https://linuxcontainers.org/incus/) REST API.
- [ExIncus.Certificates](ExIncus.Certificates.md): Manage the server's trust store (trusted client certificates).

- [ExIncus.Client](ExIncus.Client.md): Connection to an Incus server.
- [ExIncus.Event](ExIncus.Event.md): An event from the Incus event stream (`/1.0/events`), as delivered by
`ExIncus.EventListener`.
- [ExIncus.EventListener](ExIncus.EventListener.md): Listens to the Incus event stream (`/1.0/events` websocket) and fans events
out to subscriber processes - the push-based alternative to polling for
dashboards and monitors.
- [ExIncus.ExecResult](ExIncus.ExecResult.md): Result of `ExIncus.Instances.exec/4`.
- [ExIncus.Images](ExIncus.Images.md): Manage images and image aliases.
- [ExIncus.Instances](ExIncus.Instances.md): Manage instances (containers and virtual machines).
- [ExIncus.Networks](ExIncus.Networks.md): Manage networks (bridges, OVN networks, ...).
- [ExIncus.Operation](ExIncus.Operation.md): A background operation.
- [ExIncus.Operations](ExIncus.Operations.md): Query, wait on and cancel background operations.
- [ExIncus.Profiles](ExIncus.Profiles.md): Manage profiles.
- [ExIncus.Projects](ExIncus.Projects.md): Manage projects.
- [ExIncus.Server](ExIncus.Server.md): Server-level information and configuration (the `/1.0` endpoint).
- [ExIncus.Snapshots](ExIncus.Snapshots.md): Manage instance snapshots.
- [ExIncus.StoragePools](ExIncus.StoragePools.md): Manage storage pools. For volumes inside a pool see
`ExIncus.StorageVolumes`.

- [ExIncus.StorageVolumes](ExIncus.StorageVolumes.md): Manage storage volumes within a pool.

- Exceptions
  - [ExIncus.Error](ExIncus.Error.md): Error returned by any `ExIncus` function.

