Skip to main content

Getting Started

Welcome to Cloudbric WAF+ API (Partner API). This document provides guidelines for partners to integrate service via API.

Overview​

The partner API enables integrated workflows for application security service; it provides comprehensive management capabilities, such as domain registration, security configuration, certificate management, threat log analysis and reporting.

Basic Information​

ItemValue
Base URLhttps://api.example.com
API Versionv3.0.0
AuthenticationAPI Key (X-Cloudbric-Key header)
Response FormatJSON
info

The URL (https://api.example.com) is used as an example throughout this document. An API endpoint URL will be assigned upon partner registration on Cloudbric WAF+.

Prerequisites​

  1. Partner Registration: Register as a partner through your account manager.
  2. Upon registration, the following will be provided:
    • Base URL: API endpoint URL
    • API Key: Authentication key for API request
    • IP Allowlist: Allowed source IPs for API request

First API Call​

Once the API key is issued and the source IPs are allowed, you can send requests to the API endpoint URL. The following API request demonstrates how to fetch the customer list under your account.

curl -X GET https://api.example.com/partner/user/all \
  -H "X-Cloudbric-Key: <API_KEY>"

API Categories​

The Cloudbric WAF+ API is organized into the following categories:

  • Auth: API key management and IP allowlist
  • Website: Domain registration and management
  • Certificate: SSL/TLS certificate management
  • WAF: WAF policy and security mode settings
  • DDoS: DDoS protection settings
  • Bot: Bot detection and blocking
  • Custom Bot: Custom bot rule management
  • Captcha: Captcha mode settings
  • IP Control: IP-based access control
  • Malicious IP: Malicious IP detection settings
  • Country Control: Country-based access control
  • Network: Network and port configuration
  • Detection Log: Attack and traffic log queries
  • Activity Log: Console activity audit logs
  • Report: Report generation and PDF export
  • Notification: Security notification and webhook settings
  • User: User account management

Next Steps​