Create DNS Record

POST

/v1/dns-records

Create a new DNS record for a domain. If the domain uses Cloudflare, the record is also synced to Cloudflare. You may use either name or host (aliases), and either type or recordType (aliases). At least one of each pair is required.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Body Params application/jsonRequired

Example

{
    "domain": "b2bforcelabs.com",
    "type": "TXT",
    "recordType": "TXT",
    "name": "@",
    "host": "@",
    "value": "v=spf1 include:_spf.google.com ~all",
    "ttl": 3600,
    "priority": null
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/dns-records' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "b2bforcelabs.com",
    "type": "TXT",
    "recordType": "TXT",
    "name": "@",
    "host": "@",
    "value": "v=spf1 include:_spf.google.com ~all",
    "ttl": 3600,
    "priority": null
}'

Responses

🟢201

application/json

DNS record created successfully

Bodyapplication/json

Example

{
    "status": 201,
    "message": "DNS record created successfully.",
    "data": {
        "id": "clz1abc4",
        "cloudflareId": "abc123cloudflare",
        "type": "TXT",
        "recordType": "TXT",
        "name": "@",
        "host": "@",
        "value": "v=spf1 include:_spf.google.com ~all",
        "ttl": 3600,
        "priority": null,
        "domainId": "cmg9l788c0001la04ctg7t1j4"
    }
}

🟠400

🟠401

🟠404

🔴500

Get DNS Records

Update DNS Record