> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.feryrides.co.in/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.feryrides.co.in/_mcp/server.

# Health and API status check

GET https://uat.feryrides.co.in/dmrc/health

Returns service status, dependency health, and the list of available DMRC APIs.

Requires `x-api-key` header.


Reference: https://docs.feryrides.co.in/api-reference/health/check

## Authentication

- `x-api-key` header (required) — API key provided by Fery for DMRC integration.

## Response

### 200

Health check successful

- `statusCode` (integer, optional)
- `success` (boolean, optional)
- `message` (string, optional)
- `data` (HealthResponseData, optional)

## Errors

### 401 Unauthorized Error

Missing or invalid API key

- `statusCode` (integer, optional)
- `success` (boolean, optional)
- `message` (string, optional)
- `errors` (map from string to any, optional)

### 403 Forbidden Error

Invalid API key

- `statusCode` (integer, optional)
- `success` (boolean, optional)
- `message` (string, optional)
- `errors` (map from string to any, optional)

### 500 Internal Server Error

Unexpected server error

- `statusCode` (integer, optional)
- `success` (boolean, optional)
- `message` (string, optional)
- `errors` (map from string to any, optional)

## Types

### HealthResponseData

- `service` (enum, optional)
  - Allowed values: `operational`, `degraded`
- `environment` (string, optional)
- `timestamp` (datetime, optional)
- `dependencies` (HealthResponseDataDependencies, optional)
- `apis` (list of HealthResponseDataApisItems, optional)

### HealthResponseDataDependencies

- `mongodb` (string, optional)
- `firestore` (string, optional)
- `sqs` (string, optional)

### HealthResponseDataApisItems

- `method` (string, optional)
- `path` (string, optional)
- `description` (string, optional)
- `status` (enum, optional)
  - Allowed values: `active`, `degraded`

## Examples

**Response**

```json
{
  "statusCode": 200,
  "success": true,
  "message": "All systems operational.",
  "data": {
    "service": "operational",
    "environment": "production",
    "timestamp": "2026-08-31T06:44:00.000Z",
    "dependencies": {
      "mongodb": "connected",
      "firestore": "connected",
      "sqs": "configured"
    },
    "apis": [
      {
        "method": "GET",
        "path": "/health",
        "description": "Service and API status check",
        "status": "active"
      },
      {
        "method": "POST",
        "path": "/ride/fare-estimate",
        "description": "Fare estimate",
        "status": "active"
      },
      {
        "method": "POST",
        "path": "/ride/create-order",
        "description": "Create ride order",
        "status": "active"
      },
      {
        "method": "POST",
        "path": "/ride/cancel",
        "description": "Cancel ride order",
        "status": "active"
      },
      {
        "method": "POST",
        "path": "/ride/feedback",
        "description": "Submit ride feedback",
        "status": "active"
      }
    ]
  }
}
```

**SDK Code**

```python Health_check_example
import requests

url = "https://uat.feryrides.co.in/dmrc/health"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Health_check_example
const url = 'https://uat.feryrides.co.in/dmrc/health';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Health_check_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://uat.feryrides.co.in/dmrc/health"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Health_check_example
require 'uri'
require 'net/http'

url = URI("https://uat.feryrides.co.in/dmrc/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Health_check_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://uat.feryrides.co.in/dmrc/health")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Health_check_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://uat.feryrides.co.in/dmrc/health', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Health_check_example
using RestSharp;

var client = new RestClient("https://uat.feryrides.co.in/dmrc/health");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Health_check_example
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://uat.feryrides.co.in/dmrc/health")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```