Health API

Check API connectivity and validate your authentication credentials.

The Health endpoint validates your API key and confirms connectivity to the Renta API. Use it to verify credentials during setup or in monitoring systems.

Health Check

GET /v1/health

Requires a valid API key (any scope). Returns the current environment and tenant ID.

const health = await renta.health.check();
console.log(health.status);      // "ok"
console.log(health.version);     // "1.0.0"
console.log(health.environment); // "production"
console.log(health.tenant_id);   // "tenant_abc123"

curl https://api.getrenta.io/v1/health \
  -H "Authorization: Bearer renta_sk_live_..."

Response:

{
  "status": "ok",
  "version": "1.0.0",
  "environment": "production",
  "tenant_id": "tenant_abc123"
}

Field	Type	Description
`status`	string	Always `"ok"` on success
`version`	string	API version
`environment`	string	`production` or `test`
`tenant_id`	string	Your tenant identifier

Health API

Health Check

On this page