# \FormatsApi

All URIs are relative to *https://registry.example.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**disable_format**](FormatsApi.md#disable_format) | **POST** /api/v1/formats/{format_key}/disable | Disable format handler
[**enable_format**](FormatsApi.md#enable_format) | **POST** /api/v1/formats/{format_key}/enable | Enable format handler
[**get_format**](FormatsApi.md#get_format) | **GET** /api/v1/formats/{format_key} | Get format handler
[**list_formats**](FormatsApi.md#list_formats) | **GET** /api/v1/formats | List format handlers
[**test_format**](FormatsApi.md#test_format) | **POST** /api/v1/formats/{format_key}/test | Test format handler



## disable_format

> models::FormatHandler disable_format(format_key)
Disable format handler

Disables a format handler. Existing artifacts remain accessible but new uploads are rejected.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format_key** | **String** | Format handler key | [required] |

### Return type

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

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### 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)


## enable_format

> models::FormatHandler enable_format(format_key)
Enable format handler

Enables a previously disabled format handler, allowing repositories of this format to accept uploads.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format_key** | **String** | Format handler key | [required] |

### Return type

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

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### 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_format

> models::FormatHandler get_format(format_key)
Get format handler

Returns detailed information about a single format handler identified by its unique key.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format_key** | **String** | Format handler key (e.g. maven, npm, docker) | [required] |

### Return type

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

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### 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_formats

> Vec<models::FormatHandler> list_formats()
List format handlers

Returns all registered format handlers including both core and WASM-based handlers.

### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### 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)


## test_format

> models::TestResultResponse test_format(format_key)
Test format handler

Tests the format handler with sample data to verify it is functioning correctly.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**format_key** | **String** | Format handler key | [required] |

### Return type

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

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### 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)

