immich/mobile/openapi/doc/RepositoryApi.md

openapi.api.RepositoryApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
checkImportRepository	GET /yucca/repository/{id}/import
createBackup	POST /yucca/repository/{id}
createRepository	POST /yucca/repository
deleteRepository	DELETE /yucca/repository/{id}
forgetSnapshot	DELETE /yucca/repository/{id}/snapshots/{snapshot}
getRepositories	GET /yucca/repository
getRunHistory	GET /yucca/repository/{id}/runs
getSnapshotListing	GET /yucca/repository/{id}/snapshots/{snapshot}/listing
getSnapshots	GET /yucca/repository/{id}/snapshots
importRepository	POST /yucca/repository/{id}/import
inspectRepositories	GET /yucca/repository/inspect
pruneRepository	POST /yucca/repository/{id}/snapshots/prune
reconfigureRepositoryPrimaryBackend	PUT /yucca/repository/{id}/backend
restoreFromPoint	POST /yucca/repository/{id}/snapshots/{snapshot}/restore-from-point
restoreSnapshot	POST /yucca/repository/{id}/snapshots/{snapshot}
updateRepository	PATCH /yucca/repository/{id}

checkImportRepository

RepositoryCheckImportResponseDto checkImportRepository(backend, id)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final backend = backend_example; // String | 
final id = id_example; // String | 

try {
    final result = api_instance.checkImportRepository(backend, id);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->checkImportRepository: $e\n');
}

Parameters

Name	Type	Description	Notes
backend	String
id	String

Return type

RepositoryCheckImportResponseDto

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]

createBackup

LogResponseDto createBackup(id)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 

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

Parameters

Name	Type	Description	Notes
id	String

Return type

LogResponseDto

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]

createRepository

RepositoryCreateResponseDto createRepository(repositoryCreateRequestDto, backend)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final repositoryCreateRequestDto = RepositoryCreateRequestDto(); // RepositoryCreateRequestDto | 
final backend = backend_example; // String | 

try {
    final result = api_instance.createRepository(repositoryCreateRequestDto, backend);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->createRepository: $e\n');
}

Parameters

Name	Type	Description	Notes
repositoryCreateRequestDto	RepositoryCreateRequestDto
backend	String		[optional]

Return type

RepositoryCreateResponseDto

Authorization

No authorization required

HTTP request headers

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

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

deleteRepository

deleteRepository(id)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 

try {
    api_instance.deleteRepository(id);
} catch (e) {
    print('Exception when calling RepositoryApi->deleteRepository: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

forgetSnapshot

ListSnapshotsResponseDto forgetSnapshot(id, snapshot)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 
final snapshot = snapshot_example; // String | 

try {
    final result = api_instance.forgetSnapshot(id, snapshot);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->forgetSnapshot: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String
snapshot	String

Return type

ListSnapshotsResponseDto

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]

getRepositories

RepositoryListResponseDto getRepositories()

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();

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

Parameters

This endpoint does not need any parameter.

Return type

RepositoryListResponseDto

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]

getRunHistory

RunHistoryResponseDto getRunHistory(id)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 

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

Parameters

Name	Type	Description	Notes
id	String

Return type

RunHistoryResponseDto

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]

getSnapshotListing

FilesystemListingResponseDto getSnapshotListing(id, snapshot, path)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 
final snapshot = snapshot_example; // String | 
final path = path_example; // String | 

try {
    final result = api_instance.getSnapshotListing(id, snapshot, path);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->getSnapshotListing: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String
snapshot	String
path	String		[optional]

Return type

FilesystemListingResponseDto

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]

getSnapshots

ListSnapshotsResponseDto getSnapshots(id)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 

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

Parameters

Name	Type	Description	Notes
id	String

Return type

ListSnapshotsResponseDto

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]

importRepository

RepositoryCreateResponseDto importRepository(backend, id)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final backend = backend_example; // String | 
final id = id_example; // String | 

try {
    final result = api_instance.importRepository(backend, id);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->importRepository: $e\n');
}

Parameters

Name	Type	Description	Notes
backend	String
id	String

Return type

RepositoryCreateResponseDto

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]

inspectRepositories

RepositoryInspectResponseDto inspectRepositories(backend)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final backend = backend_example; // String | 

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

Parameters

Name	Type	Description	Notes
backend	String		[optional]

Return type

RepositoryInspectResponseDto

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]

pruneRepository

LogResponseDto pruneRepository(id)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 

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

Parameters

Name	Type	Description	Notes
id	String

Return type

LogResponseDto

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]

reconfigureRepositoryPrimaryBackend

RepositoryCreateResponseDto reconfigureRepositoryPrimaryBackend(id, repositoryPrimaryBackendReconfigureRequestDto)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 
final repositoryPrimaryBackendReconfigureRequestDto = RepositoryPrimaryBackendReconfigureRequestDto(); // RepositoryPrimaryBackendReconfigureRequestDto | 

try {
    final result = api_instance.reconfigureRepositoryPrimaryBackend(id, repositoryPrimaryBackendReconfigureRequestDto);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->reconfigureRepositoryPrimaryBackend: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String
repositoryPrimaryBackendReconfigureRequestDto	RepositoryPrimaryBackendReconfigureRequestDto

Return type

RepositoryCreateResponseDto

Authorization

No authorization required

HTTP request headers

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

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

restoreFromPoint

LogResponseDto restoreFromPoint(backend, id, snapshot, repositorySnapshotRestoreFromPointRequestDto)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final backend = backend_example; // String | 
final id = id_example; // String | 
final snapshot = snapshot_example; // String | 
final repositorySnapshotRestoreFromPointRequestDto = RepositorySnapshotRestoreFromPointRequestDto(); // RepositorySnapshotRestoreFromPointRequestDto | 

try {
    final result = api_instance.restoreFromPoint(backend, id, snapshot, repositorySnapshotRestoreFromPointRequestDto);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->restoreFromPoint: $e\n');
}

Parameters

Name	Type	Description	Notes
backend	String
id	String
snapshot	String
repositorySnapshotRestoreFromPointRequestDto	RepositorySnapshotRestoreFromPointRequestDto

Return type

LogResponseDto

Authorization

No authorization required

HTTP request headers

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

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

restoreSnapshot

LogResponseDto restoreSnapshot(id, snapshot, repositorySnapshotRestoreRequestDto)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 
final snapshot = snapshot_example; // String | 
final repositorySnapshotRestoreRequestDto = RepositorySnapshotRestoreRequestDto(); // RepositorySnapshotRestoreRequestDto | 

try {
    final result = api_instance.restoreSnapshot(id, snapshot, repositorySnapshotRestoreRequestDto);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->restoreSnapshot: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String
snapshot	String
repositorySnapshotRestoreRequestDto	RepositorySnapshotRestoreRequestDto

Return type

LogResponseDto

Authorization

No authorization required

HTTP request headers

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

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

updateRepository

RepositoryUpdateResponseDto updateRepository(id, repositoryUpdateRequestDto, backend)

Example

import 'package:openapi/api.dart';

final api_instance = RepositoryApi();
final id = id_example; // String | 
final repositoryUpdateRequestDto = RepositoryUpdateRequestDto(); // RepositoryUpdateRequestDto | 
final backend = backend_example; // String | 

try {
    final result = api_instance.updateRepository(id, repositoryUpdateRequestDto, backend);
    print(result);
} catch (e) {
    print('Exception when calling RepositoryApi->updateRepository: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String
repositoryUpdateRequestDto	RepositoryUpdateRequestDto
backend	String		[optional]

Return type

RepositoryUpdateResponseDto

Authorization

No authorization required

HTTP request headers

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

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