Skip to main content

AI-Ready Documentation

The Register.ly API documentation includes machine-readable resources for AI assistants, coding tools, and internal search systems.

Machine-Readable Resources​

Source Of Truth​

Use the OpenAPI specification as the canonical published inventory for:

  • Endpoint paths and HTTP methods
  • Operation names
  • Request schemas
  • Response schemas and examples
  • Required fields
  • Authentication header names

Use the narrative documentation for workflow explanation, implementation notes, validation notices, and safety guidance. The OpenAPI is authoritative only for behavior that has been production-verified; its current gaps must not be filled by inference.

Safety Guidance​

AI assistants and developer tools should not invent endpoints, parameters, authentication methods, error codes, pricing, limits, policies, or response fields.

Do not include real API keys, generated tokens, passwords, reseller account emails, customer domains, or production data in prompts, generated examples, public documentation, browser JavaScript, support tickets, or shared code snippets.

Browser-based live API execution is intentionally not enabled in the documentation. Generate tokens server-side and keep the API key private.

When answering questions about the Register.ly Domains Reseller API:

  • Prefer the OpenAPI YAML over copied HTML.
  • Treat examples as fictional values unless a private test environment is explicitly provided.
  • Use fictional domains such as example.ly.
  • State when behavior is not confirmed by the current documentation.
  • Preserve the exact label VALIDATION REQUIRED for unresolved contract details.
  • Point developers to the Register.ly client area for credentials and WHMCS registrar module downloads.