ahasend ping: Test API Connectivity

Use ahasend ping to check that the AhaSend CLI can reach the API and that your API key and account ID are valid. Handy for CI health checks.

Use AhaSend CLI ping to check your API connection and credentials; this page covers its options and results.

Before running the examples, log in with a full API key, use your verified sender domain, and replace YOUR_RESOURCE_ID with a resource UUID from your test account. Create any named template, recipient, attachment, or JSON files first. Shell examples use Bash; examples that read JSON with jq need jq installed. Sends use sandbox mode.

Overview

ahasend ping [flags]

The ping command sends a test request to the AhaSend API to verify:

• Network connectivity to AhaSend servers
• API key authentication and validity
• Account access permissions

Basic Usage

# Test with current profile
ahasend ping

# Test with specific API key
ahasend ping --api-key aha-sk-... --account-id <account-id>

# Test with specific profile
ahasend ping --profile production

Output Formats

# Default plain output
ahasend ping

# JSON output for automation
ahasend ping --output json

# Table format
ahasend ping --output table

Use Cases

• Connection Testing: Verify network connectivity to AhaSend servers
• Authentication Validation: Check if API key is valid and active
• Profile Verification: Confirm profile configuration is correct
• Health Checks: Include in monitoring scripts and CI/CD pipelines
• Troubleshooting: Debug authentication or connectivity issues

Next Steps

• Configure authentication
• Manage API keys
• Send your first message

Related Guides

• Install the CLI, CLI authentication, REST sending guide.
• SMTP settings, Node.js SDK, Go SDK.
• CLI configuration and output, API authentication, Permission scopes.
• Domain setup, Sandbox behavior.