Skip to main content

Quick Start Guide

This guide provides a step-by-step walkthrough of key API scenarios.

Scenario 1: Create a User​

Create a user under your partner account. A temporary password will be sent to the registered email address.

# Create a master user
curl -X POST https://api.example.com/partner/user/master \
  -H "X-Cloudbric-Key: <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "user_email": "user@example.com",
    "user_name": "John Doe"
  }'

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

Scenario 2: Register a Domain​

Register a domain for the created user. Once registration and onboarding are complete, WAF protection is automatically applied.

# 1. Check domain availability
curl -X GET "https://api.example.com/partner/website/check_domain?domain=example.com" \
  -H "X-Cloudbric-Key: <API_KEY>"

# 2. Register a domain for the user
curl -X POST https://api.example.com/partner/website \
  -H "X-Cloudbric-Key: <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "webserver_domain": "example.com",
    "webserver_type": "ip",
    "webserver_ip": "203.0.113.10"
  }'

Scenario 3: View Registered Domains​

Check the list and details of registered domains.

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

# Get domain details
curl -X GET https://api.example.com/partner/website/{user_domain_idx} \
  -H "X-Cloudbric-Key: <API_KEY>"

Next Steps​