Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Domains

Generated reference for Domains endpoints. This generated page groups every public API operation in the Domains category.

Endpoints

List Domains

GET /v1/public/accounts/{account_id}/domains List Domains List customer domains visible to the public API principal. Full reference: GET /v1/public/accounts/{account_id}/domains
OpenAPI reference: /openapi.en.json GET /v1/public/accounts/{account_id}/domains

Search Domains

GET /v1/public/accounts/{account_id}/domains/search Search Domains Check public domain availability for a workspace. Full reference: GET /v1/public/accounts/{account_id}/domains/search
OpenAPI reference: /openapi.en.json GET /v1/public/accounts/{account_id}/domains/search

Purchase Domains

POST /v1/public/accounts/{account_id}/domains/purchase Purchase Domains Purchase domains through the public customer API. Full reference: POST /v1/public/accounts/{account_id}/domains/purchase
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/domains/purchase

Move Domain

POST /v1/public/accounts/{account_id}/domains/{domain}/move Move Domain Move a customer domain to another workspace in the same account. Full reference: POST /v1/public/accounts/{account_id}/domains/{domain}/move
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/domains/{domain}/move

Verify Domain

POST /v1/public/accounts/{account_id}/domains/{domain}/verify Verify Domain Verify nameserver delegation for a customer domain. Full reference: POST /v1/public/accounts/{account_id}/domains/{domain}/verify
OpenAPI reference: /openapi.en.json POST /v1/public/accounts/{account_id}/domains/{domain}/verify

Get Domain

GET /v1/public/accounts/{account_id}/domains/{domain} Get Domain Return customer-facing domain detail. Full reference: GET /v1/public/accounts/{account_id}/domains/{domain}
OpenAPI reference: /openapi.en.json GET /v1/public/accounts/{account_id}/domains/{domain}

Get Domain Health

GET /v1/public/accounts/{account_id}/domains/{domain}/health Get Domain Health Return customer-facing health diagnostics for a domain. Full reference: GET /v1/public/accounts/{account_id}/domains/{domain}/health
OpenAPI reference: /openapi.en.json GET /v1/public/accounts/{account_id}/domains/{domain}/health

Update Domain

PATCH /v1/public/accounts/{account_id}/domains/{domain} Update Domain Update customer-safe domain settings. Full reference: PATCH /v1/public/accounts/{account_id}/domains/{domain}
OpenAPI reference: /openapi.en.json PATCH /v1/public/accounts/{account_id}/domains/{domain}

Delete Domain

DELETE /v1/public/accounts/{account_id}/domains/{domain} Delete Domain Delete or release a customer domain. Full reference: DELETE /v1/public/accounts/{account_id}/domains/{domain}
OpenAPI reference: /openapi.en.json DELETE /v1/public/accounts/{account_id}/domains/{domain}