Commands
Appwarden provides a set of commands to help you manage your domains, incidents, and settings. This guide will walk you through the available commands and how to use them.
The following commands are issued by interacting with the Appwarden bot from your Discord server. If you haven’t already, invite Appwarden to your Discord server and follow the getting started guide.
The /quarantine commands are used to manage the quarantine status of a domain. When a domain is quarantined and a visitor lands on any route, a lock page is displayed in place of the normal content. Quarantining a domain is useful when you suspect a security breach or otherwise want to prevent access to your domain.
/quarantine lockThe /quarantine lock command is used to place a domain under quarantine. When a domain is quarantined, a lock page is displayed in place of the normal content.
In a few seconds, your domain will be quarantined and visitors will see the lock page on every route. Changes to the quarantine state may take up to 30 seconds to propagate.
In order to quarantine a domain, the domain must be verified. You can view the verification status of your domains by navigating to Settings > Monitoring in the Appwarden dashboard.
/quarantine unlockThe /quarantine unlock command is used to remove a domain from quarantine. When a domain is unlocked, normal website content is displayed to visitors.
/quarantine testThe /quarantine test command is used to test the quarantine status of a domain. When a domain is tested, a lock page is displayed on your test page — your.app/_appwarden/test — for a few minutes before being removed.
If the lock page appears on your test page, Appwarden is correctly installed in your web project. You may re-issue the test command to unlock your test page.
If the lock page doesn’t appear within 30 seconds, please follow the troubleshooting steps in the lock page setup issues guide.
The /incident commands are used to manage incidents on your domain. An incident is created when unexpected changes to web infrastructure and response headers are detected. Incidents are used to alert your team to potential security breaches or other critical issues.
/incident declareThe /incident declare command is used to declare an incident on your domain. Declared incidents are typically used to communicate planned changes, maintenance windows, or other situations that Appwarden is unable to detect.
When an incident is declared, Appwarden creates an incident message and thread in your Discord channel to notify your team, and optionally pages your team members via PagerDuty. You may only have one active declared incident at a time.
/incident resolveThe /incident resolve command is used to resolve a declared incident on your domain.
Resolving an incident marks the incident as resolved and notifies your team.
/incident pageThe /incident page command is used to page your team members via PagerDuty, where you can configure phone call and text message alerts.
To set up PagerDuty, navigate to Settings > Integrations in the Appwarden dashboard.
/incident listThe /incident list command is used to list the ten most recent incidents on your domain.
This command shows incident status and other metadata, and can be used to find incident messages.
/incident find id:g4Dua1aThe /incident find command is used to find an incident message in your monitoring channel.
The id can be found from running /incident list. If the incident is found, click on the link to navigate to the incident message.
/incident testThe /incident test command is used to see what a real incident on your domain would look like. This command creates an incident on our test domain and displays the incident message and thread in your Discord channel.
The incident will resolve automatically after a couple minutes.
The /settings commands are used to manage your Appwarden settings.
/settings setup code:your-setup-codeThe /settings setup command changes the channel that Appwarden sends incidents and other notifications to. Replace your-setup-code with the setup code found in your Appwarden dashboard.
You can find your Discord setup code in the Appwarden dashboard at Settings > Integrations > Discord.
/helpThe /help command is used to view a partial list of Appwarden commands and other helpful information.
/inviteThe /invite command responds with a link to invite Appwarden to a Discord server.