> For the complete documentation index, see [llms.txt](https://docs.g-iot.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.g-iot.io/platform-user-guide-book/administration/api-swagger.md).

# API ( Swagger )

API settings can limit what actions (Create, Read, Delete…) can be performed based on the API key. Each key has specific permission, allowing or restricting data, while preventing updates or deletions. This is important for machine-to-machine communication, ensuring that each key can only access the designated operations. Additionally, API keys can be set up to control access to specific groups or devices, ensuring that only authorized machines can interact with those devices. This helps prevent unauthorized use of the API.\ <br>

{% hint style="success" %}
access the API DOCUMENTATION here:\
[https://app.gitbook.com/o/DKrl40rifuf7Bl8WIqXK/s/fEQ6KpTjmszWVWQqgcEa/\~/changes/211/.pdf-files-for-download/technical-.pdf](/.pdf-files-for-download/api-documetation.pdf.md)
{% endhint %}

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcIZHmnmxgNgeM1lntcWsRsBle8M48gAy_nTrdJU117-Az-JmrEOexN_i6mqjRTUgzYfXnIVVIVpNQ7ILvhrVOkQc0sCYK7V35F061Dsc462dNPjDxQSpDhE_j9Xdk6PNzcKUpP?key=ZzE-SQBxhtpTethCCNB9a49Q" alt=""><figcaption><p>Swagger API Introduction</p></figcaption></figure>

## Steps to Swagger API&#x20;

1. Navigate to Administration Menu:
   * Ensure you are in the Cockpit menu, then click on Administration.
2. Access API Section:
   * Click on API to be redirected to Swagger.
3. Authorize API Access:
   * In Swagger, click on the Authorize button.
4. Enter API Key:
   * Provide the API key to complete the authentication process.


---

# 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 dynamically by asking a question.

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

```
GET https://docs.g-iot.io/platform-user-guide-book/administration/api-swagger.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.