# Exports

### Overview

The `ban` export allows you to trigger a FiveSecure ban from any other resource on your server. It distinguishes between manual administrator bans and automated system detections.

### Usage

To call this export in your code, use the following syntax:

```lua
-- [ Server side ]

--- @param playerId integer | The server ID of the player to ban
--- @param reason string | Public ban reason shown to the player
--- @param privateReason string | Internal reason visible only to admins/logs
--- @param note string | Extra context
exports["FiveSecure"]:ban(playerId, reason, privateReason, note)
```

### Parameters

| **Parameter**   | **Type** | **Description**                                       |
| --------------- | -------- | ----------------------------------------------------- |
| `playerId`      | integer  | The server ID of the player to be banned.             |
| `reason`        | string   | The public reason shown to the player (e.g., "0x11"). |
| `privateReason` | string   | Internal details seen only by admins in the logs.     |
| `note`          | string   | Additional context.                                   |


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fivesecure.net/for-developers/exports.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
