Save Credentials or Connect Domain

POST

/v1/cloudflare-credentials

Two modes based on request body:

Mode A — Save credentials (email + apiKey + accountId): Validates credentials against the Cloudflare API, saves them, and returns the list of active zones.

Mode B — Connect domain (domainName only): Requires credentials already saved. Looks up the domain in Cloudflare and upserts it into LiteMail with registrar: CUSTOMER_CLOUDFLARE. Call GET first to see available domains, then call POST with domainName for each one you want to connect.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Example

{
    "email": "admin@company.com",
    "apiKey": "abc123globalApiKey",
    "accountId": "acc_xyz789"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/cloudflare-credentials' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "admin@company.com",
    "apiKey": "abc123globalApiKey",
    "accountId": "acc_xyz789"
}'

Responses

🟢200

application/json

Credentials saved or domain connected successfully

Bodyapplication/json

Example

{
    "success": true,
    "message": "Cloudflare credentials saved successfully.",
    "data": {
        "hasCredentials": true,
        "credentials": {
            "email": "admin@company.com",
            "apiKey": "abc123",
            "accountId": "acc_xyz789"
        },
        "domains": [
            {
                "id": "zone_abc123",
                "name": "b2bforcelabs.com",
                "status": "active",
                "isConnected": false
            }
        ],
        "totalDomains": 1
    }
}

🟠400

🟠401

🟠404

🔴500

Get Cloudflare Credentials & Zones

List Registered Webhooks