Skip to content

Latest commit

 

History

History
133 lines (86 loc) · 4.02 KB

MetadataApi.md

File metadata and controls

133 lines (86 loc) · 4.02 KB
Raw

kratos_api_dart.api.MetadataApi

Load the API package

import 'package:kratos_api_dart/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
getVersion GET /version Return Running Software Version.
isAlive GET /health/alive Check HTTP Server Status
isReady GET /health/ready Check HTTP Server and Database Status

getVersion

InlineResponse2001 getVersion()

Return Running Software Version.

This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getMetadataApi();

try {
    final response = api.getVersion();
    print(response);
} catch on DioError (e) {
    print('Exception when calling MetadataApi->getVersion: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse2001

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

isAlive

InlineResponse200 isAlive()

Check HTTP Server Status

This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getMetadataApi();

try {
    final response = api.isAlive();
    print(response);
} catch on DioError (e) {
    print('Exception when calling MetadataApi->isAlive: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

isReady

InlineResponse200 isReady()

Check HTTP Server and Database Status

This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getMetadataApi();

try {
    final response = api.isReady();
    print(response);
} catch on DioError (e) {
    print('Exception when calling MetadataApi->isReady: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]