> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/api.md).

# API

- [About](https://docs.devolutions.net/powershell-universal/api/about.md): Learn how PowerShell Universal REST API endpoints execute PowerShell scripts, configure execution environments, and tune API process performance.
- [Endpoints](https://docs.devolutions.net/powershell-universal/api/endpoints.md): Configure PowerShell Universal API endpoints with New-PSUEndpoint, covering URL routing, headers, cookies, request bodies, file uploads, and custom responses.
- [OpenAPI](https://docs.devolutions.net/powershell-universal/api/openapi.md): Generate OpenAPI documentation for PowerShell Universal endpoints, add comment-based help, and define input and output types for the Swagger dashboard.
- [Event Hubs](https://docs.devolutions.net/powershell-universal/api/event-hubs.md): Set up PowerShell Universal Event Hubs to send commands to connected agents, enabling remote script execution across distributed server environments.
- [Security](https://docs.devolutions.net/powershell-universal/api/security.md): Secure PowerShell Universal REST API endpoints with token, Windows, and cookie authentication, then enforce role-based authorization for each request.
- [Error Handling](https://docs.devolutions.net/powershell-universal/api/error-handling.md): Handle errors in PowerShell Universal REST APIs by configuring ErrorAction, returning custom status codes, and reading errors in Windows PowerShell.
- [Rate Limiting](https://docs.devolutions.net/powershell-universal/api/rate-limiting.md): Configure rate limiting in PowerShell Universal to restrict API requests per endpoint and time period, plus set allow lists for trusted clients.


---

# 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.devolutions.net/powershell-universal/api.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.
