How to find and access Inframail's API documentation
Overview
You'll learn where to find Inframail's API documentation, how to access your API key, and what resources are available to help you integrate with Inframail's email infrastructure.
Prerequisites
Active Inframail subscription
Access to your Inframail account dashboard
Compatibility
API access is available to all subscribed users across all subscription tiers.
Accessing the API documentation
Inframail provides API documentation in two locations:
1. In-app API documentation
Log in to your Inframail account at app.inframail.io
Navigate to Subscription in the left sidebar menu
Click the View API Access button in the top right corner of the page
Scroll to the API Documentation section
The in-app documentation includes:
Overview – Base URL and authentication requirements
Authentication – API key header format and example cURL requests
Email Management – Endpoints for creating, deleting, and retrieving email accounts
The in-app documentation includes copy buttons for quick access to cURL examples, the base URL, and all required API variables. Click the copy icon next to any code snippet to copy it to your clipboard.
Getting your API key and credentials
Before making API calls, you'll need to collect several pieces of information:
Creating your API key
Navigate to Subscription in the left sidebar
Click View API Access in the top right
If no API key exists, click the Add API Key button
Your API key will be generated and displayed automatically
Click Copy Key to copy your API key to the clipboard
You can only have one active API key at a time. Store it securely, as you'll need it for all API requests.
Collecting required variables
In addition to your API key, you'll need these variables for API calls:
Customer ID – Your unique customer identifier
Profile ID – Your profile identifier
Host Order IDs – Identifiers for your hosting infrastructure
All of these values are displayed in the Available Variables section on the API Access page. Each has a copy button for easy access.
If you see "No hosts found" in the Host Order IDs field, you'll need to set up your hosting infrastructure first before making certain API calls.
Understanding the API base URL
The Inframail API base URL is:
https://app.inframail.io/api/v1/host/operations/All API endpoints are accessed relative to this base URL. For example, to create an email account, you would send a POST request to:
https://app.inframail.io/api/v1/host/operations/emailAvailable API endpoints
The in-app documentation currently covers these email management operations:
Create Email Account – POST /email
Delete Email Account – DELETE /email
Get Email Accounts – GET /email
For a complete list of available endpoints, including domain management and other infrastructure operations, check the external documentation at testapp.inframail.io/docs
Testing your API connection
To verify your API key is working correctly:
Copy one of the example cURL commands from the API Documentation section
Replace the placeholder values with your actual API key and variables
Run the command in your terminal or API testing tool
Check for a successful response
If your request succeeds, you'll receive a JSON response with the requested data. If authentication fails, you'll see an error message indicating an invalid or missing API key.
Troubleshooting
Symptom | Likely Cause | Resolution |
|---|---|---|
"No API Key Found" message | API key hasn't been created yet | Click the Add API Key button on the API Access page to generate one |
"Failed to copy to clipboard" error | Browser clipboard permissions | Grant clipboard permissions to app.inframail.io in your browser settings, or manually copy the value |
Variables show "Not available" | Profile data incomplete | Contact Inframail support to verify your account setup is complete |
Authentication error in API calls | Incorrect API key format | Ensure you're using the exact API key from the API Access page without modifications |
"No hosts found" error | No hosting infrastructure set up | Complete your hosting setup before making API calls that require Host Order IDs |
What's next
Explore integration examples and automation possibilities with your infrastructure
Getting help
If you encounter issues with the API or need information about specific endpoints:
Review your API key and ensure all required variables are correctly formatted
Contact Inframail support with the specific API endpoint you're trying to use and any error messages you're receiving
When contacting support about API issues, include the HTTP status code and any error messages from your API response to help resolve the issue faster.