API

Manage API keys and explore the CustomNS API.

API Keys

Production Key

cns_prod_••••••••••••
domains:readdomains:writerecords:readrecords:write

Last used: Jul 24

Staging Key

cns_stg_••••••••••••
domains:readrecords:readrecords:write

Last used: Jul 22

CI/CD Pipeline

cns_ci_••••••••••••
records:readrecords:write

Last used: Jul 24

Code Examples

Create Domain — curl
curl -X POST https://api.customns.com/v1/domains \
  -H "Authorization: Bearer cns_prod_••••••••••••" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "unclaimedname.com",
    "registrar": "namecheap"
  }'
Example Response (201 Created)
{
  "id": "dom_9Kx2P4mNqR7j",
  "domain": "unclaimedname.com",
  "status": "pending",
  "verification": "unverified",
  "nameservers": [
    "ns1.unclaimedname.com",
    "ns2.unclaimedname.com"
  ],
  "glue_records": [
    { "hostname": "ns1.unclaimedname.com", "ipv4": "192.0.2.10" },
    { "hostname": "ns2.unclaimedname.com", "ipv4": "192.0.2.11" }
  ],
  "created_at": "2024-07-24T10:00:00Z"
}

Full API Reference

Browse all endpoints, request schemas, and response types.