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

# How to Access API Documentation

> Master the technical integration of your network security. Learn how to locate and use the REST API reference for the FREAKHOSTING Firewall.

## Developer Integration Guide

The **[API Docs](https://firewall.freakhosting.com/dashboard/api-docs)** module within the FREAKHOSTING Firewall Panel provides a complete technical reference for our RESTful interface. This documentation is essential for developers and system administrators who wish to programmatically manage network filtering, retrieve real-time telemetry, or integrate our specialized DDoS mitigation into their proprietary deployment pipelines.

<CardGroup cols={2}>
  <Card title="Difficulty" icon="gauge-low">
    Intermediate
  </Card>

  <Card title="Time" icon="clock">
    2 Minutes
  </Card>
</CardGroup>

***

## Accessing the Technical Reference

Our documentation is embedded directly within the management dashboard, ensuring that you always have access to the most up-to-date version of the API schema.

<Steps>
  <Step title="Authenticate">
    Log in to the [Firewall Portal](https://firewall.freakhosting.com) using your primary credentials.
  </Step>

  <Step title="Locate API Docs">
    Click on the **[API Docs](https://firewall.freakhosting.com/dashboard/api-docs)** tab in the primary navigation menu.
  </Step>

  <Step title="Explore Endpoints">
    The interface will dynamically load all available REST endpoints, including request methods, required parameters, and example response payloads.
  </Step>
</Steps>

***

## Authentication Standards

To interact with the API gateway, you must authenticate every request using a valid **Bearer Token** generated within the [API Keys](/portals/firewall/how-to-manage-api-keys) section of the panel.

* **Header Key:** `Authorization`
* **Header Value Format:** `Bearer [YOUR_SECURE_TOKEN]`

***

## Gateway Architecture

All requests must be directed to our secure, high-availability API gateway.

**Primary Base URL:**
`https://firewall.freakhosting.com/api/remote`

### Essential Endpoints

<AccordionGroup>
  <Accordion title="GET /ips">
    Retrieves a complete list of all protected IP addresses associated with your account, including their unique system identifiers and assigned mitigation profiles.
  </Accordion>

  <Accordion title="GET /ips/{id}/rules">
    Fetches the current filtering ruleset for a specific IP address, allowing you to audit your active security perimeter.
  </Accordion>

  <Accordion title="POST /ips/{id}/rules">
    Programmatically creates a new filtering rule (TCP, UDP, or ICMP) for the specified target. This endpoint is important for building dynamic automated response systems.
  </Accordion>
</AccordionGroup>

<Tip>
  ### use API Keys with Restrictions

  For production environments, always use an API key restricted to your management server's specific IP address. This ensures that your technical reference and active security remain protected even if your token is accidentally exposed.
</Tip>

***

<Note>
  ### Need Extra Help?

  If you encounter any issues, our support team is ready to assist:

  * **Live Chat:** Quick assistance via our website.
  * **Support Ticket:** [Open a Ticket](https://freakhosting.com/clientarea/submitticket.php)
  * **Discord:** [Join our Community](https://discord.gg/freakhosting)
  * **Email:** [support@freakhosting.com](mailto:support@freakhosting.com)
</Note>

<Tip>
  ### Save on Your Hosting

  Ready to get a new server? Use code **KB20** at checkout for **20% off** your first month!
</Tip>

***

<div align="center">
  **Last Updated:** January 2026 | **Security:** Absolute protection for your digital assets.
</div>