Netskope MCP

🚀 Netskope API 文檔

本 API 文檔提供了 Netskope 系統中各類資源的管理、監控、搜索等功能的接口說明，涵蓋用戶、發佈商、策略等多個方面，方便開發者進行系統集成和功能擴展。

📚 詳細文檔

用戶管理

listUsers

• 描述：列出所有用戶
• 請求方法：GET
• 路徑：/users
• 參數：
  • fields：可選的逗號分隔字段列表（如 name, email, role）
• 響應：

{
    "status": "success",
    "data": {
        "users": [
            {
                "id": "string",
                "name": "string",
                "email": "string",
                "role": "string"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

createUser

• 描述：創建新用戶
• 請求方法：POST
• 路徑：/users
• 請求體：

{
    "name": "string",
    "email": "string",
    "role": "string"
}

updateUser

• 描述：更新現有用戶
• 請求方法：PUT
• 路徑：/users/{userId}
• 請求體：

{
    "name": "string",
    "email": "string",
    "role": "string"
}

deleteUser

• 描述：刪除用戶
• 請求方法：DELETE
• 路徑：/users/{userId}

發佈商管理

listPublishers

• 描述：列出所有發佈商
• 請求方法：GET
• 路徑：/publishers
• 參數：
  • fields：可選的逗號分隔字段列表（如 name, status, region）
• 響應：

{
    "status": "success",
    "data": {
        "publishers": [
            {
                "id": "string",
                "name": "string",
                "status": "active" | "inactive",
                "region": "string"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

createPublisher

• 描述：創建新發布商
• 請求方法：POST
• 路徑：/publishers
• 請求體：

{
    "name": "string",
    "status": "active" | "inactive",
    "region": "string"
}

updatePublisher

• 描述：更新現有發佈商
• 請求方法：PUT
• 路徑：/publishers/{publisherId}
• 請求體：

{
    "name": "string",
    "status": "active" | "inactive",
    "region": "string"
}

deletePublisher

• 描述：刪除發佈商
• 請求方法：DELETE
• 路徑：/publishers/{publisherId}

策略管理

listPolicies

• 描述：列出所有策略
• 請求方法：GET
• 路徑：/policies
• 參數：
  • fields：可選的逗號分隔字段列表（如 name, type, status）
• 響應：

{
    "status": "success",
    "data": {
        "policies": [
            {
                "id": "string",
                "name": "string",
                "type": "firewall" | "vpn" | "auth",
                "status": "active" | "inactive"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

createPolicy

• 描述：創建新策略
• 請求方法：POST
• 路徑：/policies
• 請求體：

{
    "name": "string",
    "type": "firewall" | "vpn" | "auth",
    "status": "active" | "inactive"
}

updatePolicy

• 描述：更新現有策略
• 請求方法：PUT
• 路徑：/policies/{policyId}
• 請求體：

{
    "name": "string",
    "type": "firewall" | "vpn" | "auth",
    "status": "active" | "inactive"
}

deletePolicy

• 描述：刪除策略
• 請求方法：DELETE
• 路徑：/policies/{policyId}

監控與診斷

getUsageStats

• 描述：獲取使用統計信息
• 請求方法：GET
• 路徑：/monitoring/usage
• 參數：
  • timeRange：時間範圍（如 "last_hour", "today"）
• 響應：

{
    "status": "success",
    "data": {
        "stats": [
            {
                "timestamp": "string",
                "usage": integer,
                "peakUsage": integer
            }
        ]
    }
}

getLogs

• 描述：獲取日誌
• 請求方法：GET
• 路徑：/monitoring/logs
• 參數：
  • level：日誌級別（如 "info", "warning", "error"）
• 響應：

{
    "status": "success",
    "data": {
        "logs": [
            {
                "timestamp": "string",
                "level": "info" | "warning" | "error",
                "message": "string"
            }
        ],
        "pagination": {
            "page": integer,
            "pageSize": integer,
            "totalPages": integer,
            "totalItems": integer
        }
    }
}

升級與維護

checkUpdates

• 描述：檢查可用更新
• 請求方法：GET
• 路徑：/maintenance/updates
• 響應：

{
    "status": "success",
    "data": {
        "updates": [
            {
                "version": "string",
                "releaseDate": "string",
                "notes": "string"
            }
        ]
    }
}

applyUpdate

• 描述：應用更新
• 請求方法：POST
• 路徑：/maintenance/updates/{updateVersion}
• 響應：

{
    "status": "success",
    "message": "string"
}

驗證工具

validateName

• 描述：驗證名稱是否有效
• 請求方法：POST
• 路徑：/validation/username
• 請求體：

{
    "name": "string"
}

• 響應：

{
    "status": "success",
    "isValid": boolean
}

validateResource

• 描述：驗證資源是否存在
• 請求方法：GET
• 路徑：/validation/resource/{resourceId}
• 響應：

{
    "status": "success",
    "exists": boolean
}

搜索工具

searchUsers

• 描述：搜索用戶
• 請求方法：GET
• 路徑：/search/users
• 參數：
  • query：搜索關鍵字（如 name, email）
• 響應：

{
    "status": "success",
    "results": [
        {
            "id": "string",
            "name": "string",
            "email": "string"
        }
    ],
    "pagination": {
        "page": integer,
        "pageSize": integer,
        "totalPages": integer,
        "totalItems": integer
    }
}

searchResources

• 描述：搜索資源
• 請求方法：GET
• 路徑：/search/resources
• 參數：
  • query：搜索關鍵字（如 name, type）
• 響應：

{
    "status": "success",
    "results": [
        {
            "id": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "pagination": {
        "page": integer,
        "pageSize": integer,
        "totalPages": integer,
        "totalItems": integer
    }
}

示例請求與響應

獲取策略列表

請求：

GET /policies HTTP/1.1
Content-Type: application/json

響應：

{
    "status": "success",
    "data": {
        "policies": [
            {
                "id": "policy_001",
                "name": "Firewall Policy 1",
                "type": "firewall",
                "status": "active"
            },
            {
                "id": "policy_002",
                "name": "VPN Policy 2",
                "type": "vpn",
                "status": "inactive"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 10,
            "totalPages": 2,
            "totalItems": 15
        }
    }
}

檢查更新

請求：

GET /maintenance/updates HTTP/1.1
Content-Type: application/json

響應：

{
    "status": "success",
    "data": {
        "updates": [
            {
                "version": "2.5.0",
                "releaseDate": "2023-10-01",
                "notes": "New features and bug fixes"
            },
            {
                "version": "2.4.1",
                "releaseDate": "2023-09-15",
                "notes": "Security patches"
            }
        ]
    }
}

驗證名稱

請求：

POST /validation/username HTTP/1.1
Content-Type: application/json

{
    "name": "admin_user_123"
}

響應：

{
    "status": "success",
    "isValid": true
}

搜索用戶

請求：

GET /search/users?query=admin HTTP/1.1
Content-Type: application/json

響應：

{
    "status": "success",
    "results": [
        {
            "id": "user_001",
            "name": "Admin User 1",
            "email": "admin@company.com"
        },
        {
            "id": "user_002",
            "name": "Admin User 2",
            "email": "admin2@company.com"
        }
    ],
    "pagination": {
        "page": 1,
        "pageSize": 10,
        "totalPages": 2,
        "totalItems": 15
    }
}

⚠️ 注意事項

⚠️ 重要提示

1. 認證與授權：所有請求需要有效的認證令牌，具體請參考相關文檔。
2. 錯誤處理：如返回狀態碼為非2xx，需根據響應體中的error字段處理錯誤。
3. 速率限制：高頻率調用可能觸發速率限制，請合理控制請求次數。
4. 日誌與監控：建議開啟詳細日誌記錄以便排查問題和監控系統狀態。

如需進一步瞭解每個接口的具體參數和使用場景，建議查閱完整的 API 文檔或聯繫技術支持。