immich/mobile/openapi/doc/MetricsApi.md
Daniel Dietzler fb01bd956f
open api
2023-12-28 19:06:45 +01:00

2.2 KiB
Generated

openapi.api.MetricsApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method HTTP request Description
getMetrics PUT /metrics

getMetrics

Object getMetrics(systemConfigMetricsDto)

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);

final api_instance = MetricsApi();
final systemConfigMetricsDto = SystemConfigMetricsDto(); // SystemConfigMetricsDto | 

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

Parameters

Name Type Description Notes
systemConfigMetricsDto SystemConfigMetricsDto

Return type

Object

Authorization

cookie, api_key, bearer

HTTP request headers

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

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