Skip to content

Mantle2 General Endpoints

High-level service/health endpoints for connectivity testing and version information. No authentication required.

GET /v2/hello

Connectivity test endpoint. Returns a simple greeting message to verify the service is accessible.

Parameters

None

Request Body

None

Responses

200 OK:

json
{
	"message": "hello",
	"timestamp": "2025-01-10T16:00:00Z"
}

Notes

  • Used by Cloud and Crust for lightweight readiness checks
  • No authentication required
  • May include additional fields like timestamp in implementation
  • Suitable for health check probes (Kubernetes liveness/readiness)

GET /v2/info

Retrieve Mantle2 module information including version and build metadata.

Parameters

None

Request Body

None

Responses

200 OK:

json
{
	"version": "1.0.0",
	"name": "Mantle2",
	"environment": "production",
	"drupal_version": "11.2.0",
	"php_version": "8.4.1",
	"symfony_version": "7.3.0",
	"commit": "abc123def456",
	"generated_at": "2025-01-10T12:00:00Z"
}

Response Fields

FieldTypeDescription
versionstringMantle2 application version
namestringApplication name
environmentstringDeployment environment (production/staging)
drupal_versionstringDrupal core version
php_versionstringPHP runtime version
symfony_versionstringSymfony framework version
commitstringGit commit hash (if available)
generated_atstringISO 8601 timestamp of response generation

Notes

  • Used for version verification and debugging
  • Exact fields may vary by deployment; core fields are version, name, environment
  • No authentication required
  • Useful for monitoring and support diagnostics

Usage Examples

Health Check

bash
curl https://api.earth-app.example.com/v2/hello

Version Check

bash
curl https://api.earth-app.example.com/v2/info

Integration

These endpoints are used by:

  • Cloud Workers: Verify Mantle2 availability before making API requests
  • Crust Frontend: Check API health during SSR/ISR builds
  • Monitoring Systems: Kubernetes health checks, uptime monitors
  • CI/CD Pipelines: Verify deployment success