# \AdminApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel_backup**](AdminApi.md#cancel_backup) | **POST** /api/v1/admin/backups/{id}/cancel | Cancel a running backup
[**create_backup**](AdminApi.md#create_backup) | **POST** /api/v1/admin/backups | Create backup
[**create_instance**](AdminApi.md#create_instance) | **POST** /api/v1/instances | Create a new remote instance
[**delete_backup**](AdminApi.md#delete_backup) | **DELETE** /api/v1/admin/backups/{id} | Delete a backup
[**delete_instance**](AdminApi.md#delete_instance) | **DELETE** /api/v1/instances/{id} | Delete a remote instance
[**execute_backup**](AdminApi.md#execute_backup) | **POST** /api/v1/admin/backups/{id}/execute | Execute a pending backup
[**get_backup**](AdminApi.md#get_backup) | **GET** /api/v1/admin/backups/{id} | Get backup by ID
[**get_settings**](AdminApi.md#get_settings) | **GET** /api/v1/admin/settings | Get system settings
[**get_system_stats**](AdminApi.md#get_system_stats) | **GET** /api/v1/admin/stats | Get system statistics
[**list_backups**](AdminApi.md#list_backups) | **GET** /api/v1/admin/backups | List backups
[**list_instances**](AdminApi.md#list_instances) | **GET** /api/v1/instances | List all remote instances for the authenticated user
[**list_storage_backends**](AdminApi.md#list_storage_backends) | **GET** /api/v1/admin/storage-backends | List available storage backends.
[**proxy_delete**](AdminApi.md#proxy_delete) | **DELETE** /api/v1/instances/{id}/proxy/{path} | Proxy a DELETE request to a remote instance
[**proxy_get**](AdminApi.md#proxy_get) | **GET** /api/v1/instances/{id}/proxy/{path} | Proxy a GET request to a remote instance
[**proxy_post**](AdminApi.md#proxy_post) | **POST** /api/v1/instances/{id}/proxy/{path} | Proxy a POST request to a remote instance
[**proxy_put**](AdminApi.md#proxy_put) | **PUT** /api/v1/instances/{id}/proxy/{path} | Proxy a PUT request to a remote instance
[**restore_backup**](AdminApi.md#restore_backup) | **POST** /api/v1/admin/backups/{id}/restore | Restore from backup
[**run_cleanup**](AdminApi.md#run_cleanup) | **POST** /api/v1/admin/cleanup | Run cleanup tasks
[**run_storage_gc**](AdminApi.md#run_storage_gc) | **POST** /api/v1/admin/storage-gc | POST /api/v1/admin/storage-gc
[**trigger_reindex**](AdminApi.md#trigger_reindex) | **POST** /api/v1/admin/reindex | Trigger a full Meilisearch reindex of all artifacts and repositories.
[**trigger_search_reindex**](AdminApi.md#trigger_search_reindex) | **POST** /api/v1/admin/search/reindex | Trigger a full reindex of all artifacts and repositories in Meilisearch.
[**update_settings**](AdminApi.md#update_settings) | **POST** /api/v1/admin/settings | Update system settings



## cancel_backup

> cancel_backup(id)
Cancel a running backup

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Backup ID | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_backup

> models::BackupResponse create_backup(create_backup_request)
Create backup

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_backup_request** | [**CreateBackupRequest**](CreateBackupRequest.md) |  | [required] |

### Return type

[**models::BackupResponse**](BackupResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_instance

> models::RemoteInstanceResponse create_instance(create_instance_request)
Create a new remote instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_instance_request** | [**CreateInstanceRequest**](CreateInstanceRequest.md) |  | [required] |

### Return type

[**models::RemoteInstanceResponse**](RemoteInstanceResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_backup

> delete_backup(id)
Delete a backup

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Backup ID | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_instance

> delete_instance(id)
Delete a remote instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Remote instance ID | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## execute_backup

> models::BackupResponse execute_backup(id)
Execute a pending backup

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Backup ID | [required] |

### Return type

[**models::BackupResponse**](BackupResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_backup

> models::BackupResponse get_backup(id)
Get backup by ID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Backup ID | [required] |

### Return type

[**models::BackupResponse**](BackupResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_settings

> models::SystemSettings get_settings()
Get system settings

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::SystemSettings**](SystemSettings.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_system_stats

> models::SystemStats get_system_stats()
Get system statistics

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::SystemStats**](SystemStats.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_backups

> models::BackupListResponse list_backups(status, r#type, page, per_page)
List backups

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**status** | Option<**String**> |  |  |
**r#type** | Option<**String**> |  |  |
**page** | Option<**i32**> |  |  |
**per_page** | Option<**i32**> |  |  |

### Return type

[**models::BackupListResponse**](BackupListResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_instances

> Vec<models::RemoteInstanceResponse> list_instances()
List all remote instances for the authenticated user

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::RemoteInstanceResponse>**](RemoteInstanceResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_storage_backends

> Vec<String> list_storage_backends()
List available storage backends.

Returns the names of all configured and available storage backends. Requires admin privileges.

### Parameters

This endpoint does not need any parameter.

### Return type

**Vec<String>**

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## proxy_delete

> proxy_delete(id, path)
Proxy a DELETE request to a remote instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Remote instance ID | [required] |
**path** | **String** | Sub-path to proxy | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## proxy_get

> proxy_get(id, path)
Proxy a GET request to a remote instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Remote instance ID | [required] |
**path** | **String** | Sub-path to proxy | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## proxy_post

> proxy_post(id, path, body)
Proxy a POST request to a remote instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Remote instance ID | [required] |
**path** | **String** | Sub-path to proxy | [required] |
**body** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: application/octet-stream
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## proxy_put

> proxy_put(id, path, body)
Proxy a PUT request to a remote instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Remote instance ID | [required] |
**path** | **String** | Sub-path to proxy | [required] |
**body** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: application/octet-stream
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## restore_backup

> models::RestoreResponse restore_backup(id, restore_request)
Restore from backup

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Backup ID | [required] |
**restore_request** | [**RestoreRequest**](RestoreRequest.md) |  | [required] |

### Return type

[**models::RestoreResponse**](RestoreResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_cleanup

> models::CleanupResponse run_cleanup(cleanup_request)
Run cleanup tasks

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**cleanup_request** | [**CleanupRequest**](CleanupRequest.md) |  | [required] |

### Return type

[**models::CleanupResponse**](CleanupResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## run_storage_gc

> models::StorageGcResult run_storage_gc(storage_gc_request)
POST /api/v1/admin/storage-gc

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**storage_gc_request** | [**StorageGcRequest**](StorageGcRequest.md) |  | [required] |

### Return type

[**models::StorageGcResult**](StorageGcResult.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## trigger_reindex

> models::ReindexResponse trigger_reindex()
Trigger a full Meilisearch reindex of all artifacts and repositories.

Requires admin privileges and Meilisearch to be configured.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ReindexResponse**](ReindexResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## trigger_search_reindex

> models::ReindexResponse trigger_search_reindex()
Trigger a full reindex of all artifacts and repositories in Meilisearch.

The reindex runs asynchronously in the background. The endpoint returns immediately with a confirmation that the task was started.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ReindexResponse**](ReindexResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_settings

> models::SystemSettings update_settings(system_settings)
Update system settings

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**system_settings** | [**SystemSettings**](SystemSettings.md) |  | [required] |

### Return type

[**models::SystemSettings**](SystemSettings.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

