Skip to main content

WellKnown API

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

MethodHTTP requestDescription
getWellKnownHealthGET /.well-known/health/.well-known/health [GET]
getWellKnownVersionGET /.well-known/version/.well-known/version [Get]

getWellKnownHealth​

String getWellKnownHealth()

/.well-known/health [GET]

Retrieves the health status of the server.

Example​

import 'package:core_openapi/api.dart';

final api_instance = WellKnownApi();

try {
    final result = api_instance.getWellKnownHealth();
    print(result);
} catch (e) {
    print('Exception when calling WellKnownApi->getWellKnownHealth: $e\n');
}

Parameters​

This endpoint does not need any parameter.

Return type​

String

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: text/plain

getWellKnownVersion​

String getWellKnownVersion()

/.well-known/version [Get]

Retrieves the version of the server. It returns a string representing the current version.

Example​

import 'package:core_openapi/api.dart';

final api_instance = WellKnownApi();

try {
    final result = api_instance.getWellKnownVersion();
    print(result);
} catch (e) {
    print('Exception when calling WellKnownApi->getWellKnownVersion: $e\n');
}

Parameters​

This endpoint does not need any parameter.

Return type​

String

Authorization​

No authorization required

HTTP request headers​

  • Content-Type: Not defined
  • Accept: text/plain