# NameGrid

## Docs

- [GET /v1/account — Fetch Workspace & Credit Balance](https://docs.namegrid.org/api-reference/account/get.md): GET /v1/account — Retrieve your workspace details and current credit balance. Use this to check available credits before registering or renewing.
- [POST /v1/domains/{domain}/dns — Create a DNS Record](https://docs.namegrid.org/api-reference/dns/create.md): POST /v1/domains/{domain}/dns — Create a new DNS record. Supports A, AAAA, ALIAS, CNAME, HTTPS, MX, NS, PTR, SRV, SVCB, TLS, and TXT records.
- [DELETE /v1/domains/{domain}/dns/{id} — Delete DNS Record](https://docs.namegrid.org/api-reference/dns/delete.md): DELETE /v1/domains/{domain}/dns/{recordId} — Permanently delete a DNS record by its ID. Returns success confirmation on removal.
- [GET /v1/domains/{domain}/dns — List All DNS Records](https://docs.namegrid.org/api-reference/dns/list.md): GET /v1/domains/{domain}/dns — List all DNS records for a domain. Returns record id, type, name, TTL, value, and pending fulfillment status.
- [PATCH /v1/domains/{domain}/dns/{id} — Update DNS Record](https://docs.namegrid.org/api-reference/dns/update.md): PATCH /v1/domains/{domain}/dns/{recordId} — Partially update a DNS record. Only the fields you provide are modified; all others stay unchanged.
- [Check Domain Availability with POST /v1/domains/check](https://docs.namegrid.org/api-reference/domains/check.md): Check if one or more domains are available for registration. Batch up to 20 per request; unsupported TLDs are silently dropped from the results.
- [GET /v1/domains/{domain} — Retrieve Full Domain Details](https://docs.namegrid.org/api-reference/domains/get.md): GET /v1/domains/{domain} — Retrieve full details for a single domain including status, nameservers, auto-renew, privacy, and expiry date.
- [GET /v1/domains — List All Domains in Your Workspace](https://docs.namegrid.org/api-reference/domains/list.md): GET /v1/domains — List all domains owned by your workspace. Returns name, status, auto-renew, privacy, and expiry date for each domain.
- [PATCH /domains/{domain}/nameservers — Set Nameservers](https://docs.namegrid.org/api-reference/domains/nameservers.md): Replace a domain's nameservers with a new set of 2–13 valid hostnames. Changes apply immediately, or are queued if provisioning is still in progress.
- [POST /v1/domains — Submit a New Domain Registration](https://docs.namegrid.org/api-reference/domains/register.md): POST /v1/domains — Register a domain against your workspace. Provide contact details, registration years, auto-renew, and privacy settings.
- [POST /v1/domains/{domain}/renew — Renew a Domain Name](https://docs.namegrid.org/api-reference/domains/renew.md): POST /v1/domains/{domain}/renew — Extend a domain's registration by 1–10 years. Credits are debited atomically at the stored renewal rate.
- [PATCH /domains/{domain} — Update Auto-Renew & Privacy](https://docs.namegrid.org/api-reference/domains/update.md): Toggle auto-renew and WHOIS privacy for a domain you own. Send only the fields you want to change; unspecified fields are left exactly as they are.
- [NameGrid REST API — Base URL, Auth, and Error Codes](https://docs.namegrid.org/api-reference/overview.md): Complete reference for the NameGrid REST API. Base URL, authentication, rate limits, error codes, and response format for all endpoints.
- [NameGrid API Authentication: Keys, Scopes, and Errors](https://docs.namegrid.org/authentication.md): NameGrid authenticates via API keys in the x-api-key header. Learn how to generate keys, scope them to workspaces, and handle auth errors.
- [NameGrid Credits: Prepaid Billing for Domain Operations](https://docs.namegrid.org/concepts/credits.md): NameGrid uses a credit-based billing model where 1 credit equals $1. Credits are debited atomically when you register or renew domains.
- [Domain Lifecycle: Status, Expiry, and Fulfillment](https://docs.namegrid.org/concepts/domain-lifecycle.md): Understand how domains move through active, expiring_soon, expired, and failed states, and what pending fulfillment means for new registrations.
- [NameGrid Workspaces: Domain Isolation and Access Control](https://docs.namegrid.org/concepts/workspaces.md): Workspaces in NameGrid are isolated environments that group your domains and API keys. Each API key only accesses its own workspace.
- [Manage DNS Records for Your Domains — NameGrid API](https://docs.namegrid.org/guides/manage-dns.md): List, create, update, and delete DNS records for your NameGrid domains via the REST API. Covers A, CNAME, MX, TXT, and all supported record types.
- [Register a Domain with NameGrid: Step-by-Step Guide](https://docs.namegrid.org/guides/register-domain.md): Check availability, submit contact details, and register a domain via the NameGrid API. Covers privacy, auto-renew, credits, and error handling.
- [Renew a Domain Registration with the NameGrid API](https://docs.namegrid.org/guides/renew-domain.md): Manually renew a domain, extend registration for up to ten years, and configure auto-renew to protect against expiry using the NameGrid API.
- [NameGrid: Domain Registration & DNS Management API](https://docs.namegrid.org/introduction.md): NameGrid is a REST API for domain registration, DNS management, and renewals. Automate your domain workflows programmatically with a single API key.
- [Get Started with NameGrid: Register Your First Domain](https://docs.namegrid.org/quickstart.md): Learn how to authenticate, check domain availability, and register your first domain using the NameGrid REST API in just a few steps.