> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sentrystudios.org/llms.txt
> Use this file to discover all available pages before exploring further.

# SentryWipe

> Information regarding the upcoming SentryWipe Developer API.

<Warning>
  **API In Development**

  Currently, SentryWipe **does not** feature a public Developer API for direct programmatic integration. However, our engineering team is actively working on a robust API to be released in a future update!
</Warning>

## What's Coming?

We are building the SentryWipe API to be as flexible as possible for network developers. Here is a sneak peek at what you will be able to do:

<CardGroup cols={3}>
  <Card title="Trigger Wipes" icon="power-off" iconType="duotone">
    Programmatically initiate full, soft, or seasonal wipes from your own Java plugins.
  </Card>

  <Card title="Cancel Wipes" icon="ban" iconType="duotone">
    Dynamically intercept and cancel ongoing wipe sequences based on custom logic.
  </Card>

  <Card title="Fetch Statistics" icon="chart-simple" iconType="duotone">
    Retrieve real-time statistics regarding wipe history, durations, and affected regions.
  </Card>
</CardGroup>

***

## Current Workarounds

If you need to execute code before or after a wipe occurs *right now*, we highly recommend utilizing our robust **Hooks System**.

<Card title="Utilize Wipe Hooks" icon="link" href="https://docs.sentrystudios.org/hooks">
  The hooks system allows you to bind console commands to specific wipe stages (e.g., `pre_wipe`, `post_wipe`). This effectively acts as a bridge, allowing you to trigger custom plugin commands, execute scripts, or broadcast messages dynamically during a wipe cycle!
</Card>

***

## Shape the API

Are there specific methods, events, or data points you'd like to see included in the upcoming Developer API? We'd love to hear your thoughts!

<CardGroup cols={2}>
  <Card title="Join our Discord" icon="discord" iconType="solid" href="https://discord.com/invite/wN2ExrSkS4">
    Drop your ideas in our suggestions channel. We actively shape our API based on what server developers need most.
  </Card>

  <Card title="Open a Ticket" icon="ticket" iconType="duotone" href="https://sentrystudios.org/support">
    For detailed API requests or custom integration inquiries, open a support ticket on our website.
  </Card>
</CardGroup>