get__health

GET /health

Health Check

Comprehensive health check of the API and its dependencies.

Returns detailed status information about:

• Database connectivity

• External service dependencies

• System resources

Use this endpoint for monitoring and alerting systems.

TypeScript Client Library

// Using the Flashback TypeScript client
import { FlashbackClient } from '@flashback/client';

const client = new FlashbackClient({
  accessToken: 'your-access-token'
});

// Check API health
try {
  const result = await client.health.check();
  console.log('Health status:', result);
} catch (error) {
  console.error('Health check failed:', error);
}

Code Samples

Shell

# You can also use wget
curl -X GET https://backend.flashback.tech/health \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

HTTP

GET https://backend.flashback.tech/health HTTP/1.1
Host: localhost:3000
Accept: application/json

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/health',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://backend.flashback.tech/health',
  params: {
  }, headers: headers

p JSON.parse(result)

Python

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://backend.flashback.tech/health', headers = headers)

print(r.json())

PHP

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://backend.flashback.tech/health', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Java

URL obj = new URL("https://backend.flashback.tech/health");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Go

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://backend.flashback.tech/health", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Example responses

200 Response

{
  "status": "ok",
  "timestamp": "2019-08-24T14:15:22Z",
  "error": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Health status	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» status	string	false	none	Overall health status
» timestamp	string(date-time)	false	none	When the health check was performed
» error	string	false	none	Error message if status is error

Enumerated Values

Property	Value
status	ok
status	error