> For the complete documentation index, see [llms.txt](https://docs.clashperk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clashperk.com/others/whitelist.md).

# Whitelist

Open a single command to a specific user or role, and lock it for everyone else.

The whitelist controls who can use **one specific command**. Whitelist a user or role for a command and two things happen:

* **They can use it**, even if it normally needs Manage Server or a manager role. A few actions inside a command, such as linking a player to someone else, still check for the matching manager role.
* **Everyone else is blocked** from it, unless they have Manage Server or the [Bot Manager](https://docs.clashperk.com/others/bot-manager.md) role.

{% hint style="info" %}
**Example:** let your `@War Caller` role run <mark style="color:blue;">**/roster ping**</mark> to remind roster members before war, without giving them any other roster or admin commands.
{% endhint %}

## Whitelist a command

<mark style="color:blue;">**/whitelist**</mark> <mark style="color:purple;">**user\_or\_role:**</mark> `@War Caller` <mark style="color:purple;">**command:**</mark> `/roster ping`

Run it again with another user or role to add more people to the same command.

## See or remove whitelists

| To                                   | Run                                                                                                                                                                                                                                      |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List every whitelisted command       | <mark style="color:blue;">**/whitelist**</mark> <mark style="color:purple;">**list:**</mark> `True`                                                                                                                                      |
| Remove a user or role from a command | <mark style="color:blue;">**/whitelist**</mark> <mark style="color:purple;">**user\_or\_role:**</mark> `@War Caller` <mark style="color:purple;">**command:**</mark> `/roster ping` <mark style="color:purple;">**clear:**</mark> `True` |

{% hint style="warning" %}
Once a command has a whitelist, it's locked for everyone not on it — including members who could use it before. Remove all entries to open it again.
{% endhint %}

## Whitelist or manager role?

| Use                                                                   | When                                                                                                                  |
| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| **Whitelist**                                                         | You want to open one command to someone. Applies to slash commands only — not buttons or menus on the bot's messages. |
| [**Manager roles**](https://docs.clashperk.com/others/bot-manager.md) | You want someone to manage a whole area (rosters, links, flags, or everything), including the buttons and menus.      |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.clashperk.com/others/whitelist.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
