# Self-host Apprise API

> A single HTTP endpoint that fans a notification out to 100+ services such as Slack, Discord, and email.

- Page: https://levelrail.com/templates/apprise-api/
- JSON: https://levelrail.com/templates/apprise-api.json
- Category: Communication
- Licence: MIT (Permissive license)
- Source: https://github.com/caronc/apprise-api
- Upstream docs: https://github.com/caronc/apprise-api

## Requirements
- Memory: about 128 MiB
- amd64: published, arm64: tested
- Needs configuration before start: no
- Pinned image tag: 1.5.4

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| apprise-api | caronc/apprise | 1.5.4 | 8000 | apprise_config -> /config; apprise_attach -> /attachments |

## Deploy

### CLI

```bash
levelrail-cli templates deploy apprise-api --name my-apprise-api
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/apprise-api/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### Can I deploy Apprise API on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id apprise-api for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image caronc/apprise:1.5.4 is what you deploy there.

Self-host Apprise API, Apprise API docker compose file, deploy Apprise API on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
