termius/api-bridge repository overview

⁠What is Termius API Bridge?

Termius⁠ API Bridge is a REST API that enables you to create and delete data, including hosts, groups, and credentials, in your Termius vaults.

⁠Use cases

API Bridge is designed to synchronize your infrastructure with your Termius vault. Its primary use case is automatically adding and removing hosts in your Termius vault as they spin up or shut down. For example, you could add a new host when an AWS Auto Scaling group launches a new EC2 instance.

⁠Quick reference

• API Bridge Documentation⁠
• Complete OpenAPI Specification⁠

⁠How to set up the API Bridge

1. Log in or create your Termius account.
2. API Bridge requires a Team plan. Start a 14-day Team trial by inviting your teammate⁠.
3. Open the API Bridge page⁠.
4. Add an API Bridge and follow the instructions inside the API Bridge page.

⁠Deployment with Docker Compose

1. Download the compose.yml file:

services:
  termius-api-bridge:
    image: termius/api-bridge:latest
    container_name: termius-api-bridge
    ports:
      - "8080:8080"
    volumes:
      - "./termius-bridge-credentials.json:/home/termius/.termius/termius-bridge-credentials.json"
    restart: unless-stopped

1. Move termius-bridge-credentials.json (downloaded during the API Bridge setup) to the same directory as compose.yml, or update the volumes section with the correct path to termius-bridge-credentials.json.
2. Run the API Bridge container:

docker compose up -d