From 8cbb3c47187069155196fbbbdbf507b615a1e125 Mon Sep 17 00:00:00 2001 From: Eli Bosley Date: Tue, 11 Feb 2025 15:56:54 -0500 Subject: [PATCH] feat: public index --- api/docs/public/index.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 api/docs/public/index.md diff --git a/api/docs/public/index.md b/api/docs/public/index.md new file mode 100644 index 000000000..b297a7042 --- /dev/null +++ b/api/docs/public/index.md @@ -0,0 +1,35 @@ +# Unraid API Documentation + +The Unraid API provides a powerful GraphQL interface for interacting with your Unraid server programmatically. It enables automation, monitoring, and integration capabilities for your Unraid system. + +## Current Availability + +The Unraid API is currently available exclusively through the **Unraid Connect Plugin**. To get started: + +1. Install the Unraid Connect Plugin from the Apps tab +2. Configure the plugin according to your needs +3. Access the API functionality through the plugin interface + +## Future Availability + +The API will be integrated directly into the Unraid operating system in an upcoming OS release. This integration will: + +- Make the API a core part of the Unraid system +- Remove the need for separate plugin installation +- Enable deeper system integration capabilities + +## Documentation Sections + +- [How to Use the API](./how-to-use-the-api.md) - Comprehensive guide on using the GraphQL API +- [CLI Commands](./cli.md) - Reference for all available command-line interface commands +- [Upcoming Features](./upcoming-features.md) - Roadmap of planned features and improvements + +## Key Features + +- **GraphQL Interface**: Modern, flexible API design with strong typing +- **Authentication**: Secure access through API keys or session cookies +- **Comprehensive Coverage**: Access to system info, array management, Docker operations, and more +- **Developer Tools**: Built-in GraphQL sandbox for easy exploration and testing +- **Role-Based Access**: Granular control over API permissions and access levels + +For detailed information about using the API, please refer to the [How to Use the API](./how-to-use-the-api.md) guide.