API Reference Overview (v1.2)

Guide to common API specifications and authentication methods for controlling and monitoring GIIP platform microservices and database resources.

📋 Overview

The GIIP API follows RESTful architecture principles, processing requests and returning responses in JSON format. All APIs are accessible only via the HTTPS protocol for security, and valid Access and Secret Keys are required for successful function calls.

🔐 Authentication

The following authentication information must be included in all API request headers.

Header Key	Description
x-giip-ak	Access Key issued by the GIIP administrator
x-giip-sk	Secret Key issued by the GIIP administrator

[!IMPORTANT] The Secret Key must not be leaked to the outside and should be securely managed on the server side to avoid direct exposure in client-side JavaScript (JS) code.

📡 Common Response Format

All GIIP APIs provide a consistent response format to facilitate client-side processing.

{
  "RstVal": 0,
  "RstMsg": "Success",
  "Data": { ... }
}

• RstVal: Success status (0: Success, otherwise: Error)
• RstMsg: Success message (Includes detailed reason on error)
• Data: Data body returned upon success

🚀 Request Format

All API requests are POSTed as

application/x-www-form-urlencoded

following the Azure Function call specification.

Key Form Data

Field	Description
text	Command string to execute
user_id	Calling user ID
token	Session token
usertoken	Session token used for actual integration

---

🚀 Guides by API Group

Refer to the individual guides below for detailed API specifications by field.

1. Server Management API: Infrastructure asset query and command execution
2. Database API: DB performance and query statistics
3. Issue Management API: Failure alarms and status updates
4. Cost Analysis API: Cloud usage and cost prediction
5. Project/User API: Permissions and organization management
6. Monitoring Data Query API: Real-time CPU/MEM/Disk metrics, performance history, and process list
7. Network Security Policy API: Firewall rule query, IP allow/block, and policy batch deployment
8. Network Topology (Net3D) API: Infrastructure connection data collection and transmission specifications (netinv, netstat, db_connections)
9. System Management API: Remote command execution, agent control, and server tag management
10. KVS (Key-Value Store) API: Factor data query (KVSFactorLast, KVSFactorList)
11. Vercel Management API: Vercel configuration management and deployment history query
12. GitHub Actions Management API: GitHub repository integration and workflow history query
13. Email Server Management API: SMTP server configuration and test sending (Admin only)
14. Sk3 (High-fidelity Logging) API: High-fidelity logging bridge for agent transmission error detection and integrity verification
15. Common Response & Result Codes (RstVal): Standard result codes guide based on the tDefRst table

---

🛠️ Common Error Codes

• 401 Unauthorized: Authentication information is invalid or expired
• 403 Forbidden: No permission to call the specified API (Includes IP-based access control)
• 429 Too Many Requests: Rate limit exceeded
• 500 Internal Server Error: Internal server error or temporary failure occurred

📖 Developer Notes

• Endpoint Caller:

  src/lib/lsvrUtils.ts

• Session Management: Reference

  sessionStorage

  's

  user_id

  ,

  token

  ,

  csn

  ,

  cname

  , etc.
• All integrations default to HTTPS.

---

Version: 1.2 Last Updated: 2026-04-11 Markdown Source: giipv3/public/help/api-reference.en.md