InfoApi

All URIs are relative to http://localhost/api

infoHealth

string infoHealth()

Lightweight endpoint for health monitoring that returns only the essential health status information.

Example

import {
    InfoApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new InfoApi(configuration);

const { status, data } = await apiInstance.infoHealth();

Parameters

This endpoint does not have any parameters.

Return type

string

Authorization

http

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | | - |

Back to top Back to API list Back to Model list Back to README

infoIndex

string infoIndex()

Returns basic application information including: - Application name and version - Health check status for key services - Timestamp of the response

Example

import {
    InfoApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new InfoApi(configuration);

const { status, data } = await apiInstance.infoIndex();

Parameters

This endpoint does not have any parameters.

Return type

string

Authorization

http

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | | - |

Back to top Back to API list Back to Model list Back to README

infoVersion

InfoVersion200Response infoVersion()

Simple endpoint that returns just the version information for deployment tracking and API compatibility checks.

Example

import {
    InfoApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new InfoApi(configuration);

const { status, data } = await apiInstance.infoVersion();

Parameters

This endpoint does not have any parameters.

Return type

InfoVersion200Response

Authorization

http

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.