Unregistry REST API Documentation

Register a new registrant account and receive an API key.

Request Body

curl -X POST https://com.store/api/v2/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "securePassword123",
    "organization": "Example Corp",
    "contact_name": "John Doe"
  }'

const response = await fetch('https://com.store/api/v2/auth/register', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: '[email protected]',
    password: 'securePassword123',
    organization: 'Example Corp',
    contact_name: 'John Doe'
  })
});

const data = await response.json();

import requests

response = requests.post(
    'https://com.store/api/v2/auth/register',
    json={
        'email': '[email protected]',
        'password': 'securePassword123',
        'organization': 'Example Corp',
        'contact_name': 'John Doe'
    }
)

data = response.json()

{
  "success": true,
  "message": "Registration successful",
  "data": {
    "registrant_id": 123,
    "api_key": "sk_live_a1b2c3d4e5f6g7h8i9j0",
    "organization": "Example Corp"
  }
}

Generate a new API token using email and password credentials.

Request Body

Check if a subdomain is available for registration.

Path Parameters

curl -X GET https://com.store/api/v2/subdomains/shop \
  -H "X-API-Key: your_api_key"

{
  "success": true,
  "data": {
    "subdomain": "shop",
    "available": true,
    "premium": false,
    "price": {
      "registration": 29.99,
      "renewal": 29.99,
      "currency": "USD"
    }
  }
}

Register a new subdomain.

Request Body

curl -X POST https://com.store/api/v2/subdomains \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "subdomain": "shop",
    "domain": "com.store",
    "period": 2,
    "auto_renew": true,
    "dns_records": [
      {
        "type": "A",
        "value": "192.168.1.1"
      }
    ]
  }'

Update subdomain settings and configuration.

Delete a subdomain (requires confirmation).

List all subdomains owned by the authenticated registrant.

Query Parameters

Get all DNS records for a subdomain.

Add a new DNS record.

Request Body

Update an existing DNS record.

Delete a DNS record.

Register a webhook endpoint to receive real-time notifications.

Available Events

Webhook Payload Example

{
  "event": "subdomain.registered",
  "timestamp": "2025-01-08T12:00:00Z",
  "data": {
    "subdomain": "shop.com.store",
    "registrant_id": 123,
    "registered_at": "2025-01-08T12:00:00Z",
    "expires_at": "2026-01-08T12:00:00Z",
    "auto_renew": true
  },
  "signature": "sha256=abcdef1234567890..."
}