The OpenSRS API lets resellers integrate their systems directly with OpenSRS to manage domains, email, trust services, and publishing. This article is a starting point for finding the right API reference for the product you are integrating with. Use the links below to jump to the official command reference and integration documentation.
About the OpenSRS API documentation
The OpenSRS API Guide outlines all available OpenSRS API commands and explains how to integrate with the OpenSRS system. It combines the service-specific command references with the API integration guide in a single, searchable location.
Note: With the exception of the Email API documentation, the most current documentation is now hosted at domains.opensrs.guide.
Primary reference: Domains API
The Domains API Guide is the authoritative reference for all domain-related API commands. It covers authentication, request and response formats, command syntax, and integration patterns.
- Quickstart and full Domains API reference:https://domains.opensrs.guide/docs/quickstart
Product-specific command references
Separate guides exist for each OpenSRS product. The Domains, Trust Service, and Publishing references are now maintained at domains.opensrs.guide. The Email API documentation remains in the legacy product guide.
Product | Reference location |
|---|---|
Domains | |
Trust Service (SSL) | |
Publishing Service |
Warning: Attached product guide PDFs that previously lived on this support article have not been migrated.
How to choose the right guide
- Building a new integration: start with the Quickstart at domains.opensrs.guide/docs/quickstart for environment setup, authentication, and your first API call.
- Looking up a specific command: use the command reference for the product you are working with (Domains, Trust, Email, or Publishing).
- Troubleshooting an error response: see the response code reference at domains.opensrs.guide/docs/codes.
Next steps
- Generate your API key. Follow the API Key and IP Access guide to retrieve your private key and configure allowed IP addresses before making your first call.
- Review event notifications. Configure email or API polling notifications so your integration can react to asynchronous domain events.
- Bookmark the response codes reference. Knowing common response codes will speed up debugging during development.
Questions? Contact OpenSRS Support.
How helpful was this article?
Thanks for your feedback!
Do you still need help? If so please submit a request here.