# Signal CLI REST API

Signal CLI REST API is a self-hosted Docker container that wraps signal-cli, the command-line client for the Signal messenger, in a Representational State Transfer (REST) API. It is open source and self-hosted, installable on Docker Hub, Unraid, Kubernetes (Helm) and TrueNAS.

Canonical page: https://ourlocalhost.com/app/3741/signal-cli-rest-api

## Description

Signal CLI REST API is a self-hosted Docker container that wraps signal-cli, the command-line client for the Signal messenger, in a Representational State Transfer (REST) API. It exposes core Signal features such as registering and verifying a number, sending and receiving messages with attachments, linking devices, and creating, listing, and removing groups, so you can script and automate Signal from your own services, chatbots, or home automation. It is well suited to homelabbers who want a programmatic way to integrate Signal messaging into their own backends.

## Platform availability

Available on 3 of 10 platforms: Unraid, TrueNAS, Helm.

## Health score

80/100 (Excellent), based on 3 of 4 factors.
- Maintained: 100 (last commit 10 days ago)
- Popular: 69 (2,920 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)

## Links

- Official website: https://bbernhard.github.io/signal-cli-rest-api/
- Docker Hub: https://hub.docker.com/r/bbernhard/signal-cli-rest-api
- Unraid: https://ca.unraid.net/apps/signal-api-1rzkuax0oq5etp?q=Signal-API
- Kubernetes (Helm): https://artifacthub.io/packages/helm/geek-cookbook/signal-cli-rest-api
- TrueNAS: https://apps.truenas.com/catalog/signal-cli-rest-api/
- GitHub: https://github.com/bbernhard/signal-cli-rest-api

## Common questions

### How do I choose the API execution mode?

Set the MODE environment variable to select the execution mode. Normal mode is the default and invokes signal-cli for every REST API request.

### What should I check if the Docker container exits with code 0?

Make sure the host port is not already occupied by another process.

### Can this be used with Uptime Kuma Signal notifications?

Yes, a self-hoster installed signal-cli-rest-api after seeing it mentioned in Uptime Kuma's Signal notification setup.

### Does the API support device linking, groups, and attachments?

Yes, it can link devices, create and manage groups, and handle attachments, in addition to registering a number and sending or receiving messages.

## Alternatives

- Briar: Censorship-resistant peer-to-peer messaging that bypasses centralized servers.
- Conduit: Conduit is a lightweight, self-contained Matrix server written in Rust for running your own chat backend with minimal setup and low system…
- Discord
- Element
- Jami: Jami is a free/libre, end-to-end encrypted communication app for private messaging, voice calls, and video conferences.
- Jitsi Meet: Jitsi Meet is an open-source, self-hosted video conferencing platform offering HD audio and video, screen sharing, in-meeting chat, and unl…
- Matrix: Matrix is a free, open-source protocol and server for secure, decentralized real-time messaging.
- RetroShare: RetroShare is a free, open-source, decentralized communication toolkit that establishes encrypted peer-to-peer connections between your dev…
- SimpleX Chat: SimpleX Chat is a private messaging app that protects your identity by not using phone numbers or usernames.
- Telegram: Telegram is a cloud-based mobile and desktop messaging app.
- Tencent QQ: QQ is a widely used Chinese instant messaging service developed by Tencent, offering chat, voice, and video communication.
- Threema: Threema is a new mobile messaging app that puts security first.

---
Source: Our Local Host (https://ourlocalhost.com/app/3741/signal-cli-rest-api), the self-hosted and open-source app directory.
