Endpoints

The endpoint URL is the target of your API test.

URL Format

Enter the full URL including:

• Protocol (https:// or http://)
• Domain
• Path
• Query parameters (if needed)

Examples:

https://api.example.com/v1/health
https://api.example.com/users?limit=1
https://staging.example.com:8080/api/status

Best Practices

Use HTTPS

Always prefer HTTPS endpoints for security. HTTP endpoints are supported but not recommended for production monitoring.

Health Check Endpoints

Many APIs provide dedicated health check endpoints:

/health
/healthz
/status
/ping
/_health

These are ideal for monitoring because they:

• Are lightweight and fast
• Don't have side effects
• Often check internal dependencies

Environment-Specific URLs

Create separate tests for each environment:

• https://api.example.com/health (Production)
• https://staging-api.example.com/health (Staging)
• https://dev-api.example.com/health (Development)

Use importance levels to control severity based on environment.

Query Parameters

Include query parameters directly in the URL:

https://api.example.com/search?q=test&limit=1

For complex parameters, ensure proper URL encoding:

https://api.example.com/search?filter=status%3Dactive

Dynamic Values

Some endpoints require dynamic values. Pingward supports variable substitution in URLs:

Variable	Description
	Current Unix timestamp
	Current date (YYYY-MM-DD)
	Random UUID

Example:

https://api.example.com/cache-bust?t={{timestamp}}

Port Numbers

For non-standard ports, include the port in the URL:

https://api.example.com:8443/health

IP Addresses

Pingward supports monitoring endpoints using IP addresses (IPv4 or IPv6) instead of hostnames.

Examples:

https://192.168.1.100/health
http://10.0.0.1:8080/api/status
https://[2001:db8::1]/api/v1/health

When using IP addresses with virtual hosts or SNI, provide a Host header override in the Host Header field.

See IP Address Monitoring for detailed documentation.