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

# Gorelo API 總覽

> 使用 Gorelo API 將外部產品與自動化流程整合到你的 MSP 平台，透過 X-API-Key 標頭進行 API 金鑰驗證、範圍化權限控管與 HTTP 錯誤狀態處理，並依你的 Gorelo 執行個體選擇正確的 base URL 發送請求，快速串接第三方系統。

Gorelo 可讓你透過 Gorelo API 與任何外部產品整合。

Gorelo API 使用 API 金鑰。請在每個請求中透過 X-API-Key 標頭夾帶你的金鑰。

Gorelo 的 base URL 取決於你在 Gorelo 中選擇用於託管資料的區域：

<Tabs>
  <Tab title="US">
    Base URL：[**https://api.usw.gorelo.io/**](https://api.usw.gorelo.io/)\
    API 參考文件：[**https://api.usw.gorelo.io/swagger**](https://api.usw.gorelo.io/swagger)
  </Tab>

  <Tab title="Australia">
    Base URL：[**https://api.aue.gorelo.io/**](https://api.aue.gorelo.io/)\
    API 參考文件：[**https://api.aue.gorelo.io/swagger**](https://api.aue.gorelo.io/swagger)
  </Tab>
</Tabs>

## 範圍與權限

API 金鑰可以被**範圍化（scoped）**。若某個金鑰缺乏對某個端點的存取權，API 會回傳 **403 Forbidden**。

## 錯誤處理

| 錯誤                        | 意義            |
| :------------------------ | :------------ |
| **401 Unauthorized**      | 缺少／無效的 API 金鑰 |
| **403 Forbidden**         | 金鑰有效，但範圍權限不足  |
| **429 Too Many Requests** | 已超過速率限制       |

## 狀態 ID

## Agent assets

| ID | 狀態                    |
| :- | :-------------------- |
| 1  | Installing            |
| 2  | Online                |
| 3  | Offline               |
| 4  | Pending Delete        |
| 5  | Deleted               |
| 6  | Pending Client Delete |
| 7  | Client Deleted        |