Getting Started

Base URL

Every path in these docs is relative to https://namecrane.org/api/v1.

API Keys

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer crane_AbCdEf1234567890...

API keys are created in My Profile > API Keys in the client portal. The full key is shown once, when it’s created, so store it somewhere safe.

IP Whitelisting

Keys can optionally restrict access to specific IPs or CIDR ranges. Requests from non-whitelisted IPs receive 401 Unauthorized.

Access Scopes

• Full Access: every domain, DNS zone, registrar operation, CraneMail and CraneBase service, and crate on the account. It’s its own setting: a key with no scopes and no Full Access reaches nothing.
• Restricted (with scopes): only the DNS domains, CraneMail and CraneBase services, and crates it names. Registrar operations (register, renew, transfer) are blocked for restricted keys.

Each scope has independent read/write permissions:

• Read: GET requests
• Write: POST, PUT, DELETE requests