Netskope MCP

🚀 Netskope API Documentation

This API documentation provides detailed information about the Netskope API, including user management, publisher management, policy management, and more. It also includes example requests and responses, as well as important notes for using the API.

📚 Documentation

User Management

listUsers

• Description: List all users.
• Request Method: GET
• Path: /users
• Parameters:
  • fields: Optional comma-separated list of fields (e.g., name, email, role).
• Response:

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

createUser

• Description: Create a new user.
• Request Method: POST
• Path: /users
• Request Body:

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

updateUser

• Description: Update an existing user.
• Request Method: PUT
• Path: /users/{userId}
• Request Body:

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

deleteUser

• Description: Delete a user.
• Request Method: DELETE
• Path: /users/{userId}

Publisher Management

listPublishers

• Description: List all publishers.
• Request Method: GET
• Path: /publishers
• Parameters:
  • fields: Optional comma-separated list of fields (e.g., name, status, region).
• Response:

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

createPublisher

• Description: Create a new publisher.
• Request Method: POST
• Path: /publishers
• Request Body:

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

updatePublisher

• Description: Update an existing publisher.
• Request Method: PUT
• Path: /publishers/{publisherId}
• Request Body:

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

deletePublisher

• Description: Delete a publisher.
• Request Method: DELETE
• Path: /publishers/{publisherId}

Policy Management

listPolicies

• Description: List all policies.
• Request Method: GET
• Path: /policies
• Parameters:
  • fields: Optional comma-separated list of fields (e.g., name, type, status).
• Response:

{
    "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

• Description: Create a new policy.
• Request Method: POST
• Path: /policies
• Request Body:

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

updatePolicy

• Description: Update an existing policy.
• Request Method: PUT
• Path: /policies/{policyId}
• Request Body:

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

deletePolicy

• Description: Delete a policy.
• Request Method: DELETE
• Path: /policies/{policyId}

Monitoring and Diagnosis

getUsageStats

• Description: Get usage statistics.
• Request Method: GET
• Path: /monitoring/usage
• Parameters:
  • timeRange: Time range (e.g., "last_hour", "today").
• Response:

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

getLogs

• Description: Get logs.
• Request Method: GET
• Path: /monitoring/logs
• Parameters:
  • level: Log level (e.g., "info", "warning", "error").
• Response:

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

Upgrade and Maintenance

checkUpdates

• Description: Check for available updates.
• Request Method: GET
• Path: /maintenance/updates
• Response:

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

applyUpdate

• Description: Apply an update.
• Request Method: POST
• Path: /maintenance/updates/{updateVersion}
• Response:

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

Validation Tools

validateName

• Description: Validate if a name is valid.
• Request Method: POST
• Path: /validation/username
• Request Body:

{
    "name": "string"
}

• Response:

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

validateResource

• Description: Validate if a resource exists.
• Request Method: GET
• Path: /validation/resource/{resourceId}
• Response:

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

Search Tools

searchUsers

• Description: Search for users.
• Request Method: GET
• Path: /search/users
• Parameters:
  • query: Search keyword (e.g., name, email).
• Response:

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

searchResources

• Description: Search for resources.
• Request Method: GET
• Path: /search/resources
• Parameters:
  • query: Search keyword (e.g., name, type).
• Response:

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

💻 Usage Examples

Example Requests and Responses

Get Policy List

Request:

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

Response:

{
    "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
        }
    }
}

Check for Updates

Request:

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

Response:

{
    "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"
            }
        ]
    }
}

Validate Name

Request:

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

{
    "name": "admin_user_123"
}

Response:

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

Search for Users

Request:

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

Response:

{
    "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
    }
}

⚠️ Important Notes

⚠️ Important Note

• Authentication and Authorization: All requests require a valid authentication token. Please refer to the relevant documentation for details.
• Error Handling: If the returned status code is not in the 2xx range, handle the error according to the error field in the response body.
• Rate Limiting: High-frequency calls may trigger rate limiting. Please control the number of requests reasonably.
• Logging and Monitoring: It is recommended to enable detailed logging for troubleshooting and monitoring the system status.

For further information on the specific parameters and use cases of each interface, it is recommended to consult the complete API documentation or contact technical support.