cupcontrol/scp_core/docs/DefaultApi.md

# \DefaultApi

All URIs are relative to *https://www.servercontrolpanel.de/scp-core*

Method | HTTP request | Description
------------- | ------------- | -------------
[**api_ping_get**](DefaultApi.md#api_ping_get) | **GET** /api/ping | Check if application is available
[**api_v1_maintenance_get**](DefaultApi.md#api_v1_maintenance_get) | **GET** /api/v1/maintenance | Get maintenance information for system
[**api_v1_openapi_get**](DefaultApi.md#api_v1_openapi_get) | **GET** /api/v1/openapi | Get openapi spec
[**api_v1_rdns_ipv4_ip_delete**](DefaultApi.md#api_v1_rdns_ipv4_ip_delete) | **DELETE** /api/v1/rdns/ipv4/{ip} | Delete an rDNS entry of an IPv4.
[**api_v1_rdns_ipv4_ip_get**](DefaultApi.md#api_v1_rdns_ipv4_ip_get) | **GET** /api/v1/rdns/ipv4/{ip} | Get rDNS for an IPv4.
[**api_v1_rdns_ipv4_post**](DefaultApi.md#api_v1_rdns_ipv4_post) | **POST** /api/v1/rdns/ipv4 | Set an rDNS entry for an IPv4.
[**api_v1_rdns_ipv6_ip_delete**](DefaultApi.md#api_v1_rdns_ipv6_ip_delete) | **DELETE** /api/v1/rdns/ipv6/{ip} | Delete an rDNS entry of an IPv6.
[**api_v1_rdns_ipv6_ip_get**](DefaultApi.md#api_v1_rdns_ipv6_ip_get) | **GET** /api/v1/rdns/ipv6/{ip} | Get rDNS for an IPv6.
[**api_v1_rdns_ipv6_post**](DefaultApi.md#api_v1_rdns_ipv6_post) | **POST** /api/v1/rdns/ipv6 | Set an rDNS entry for an IPv6.
[**api_v1_servers_get**](DefaultApi.md#api_v1_servers_get) | **GET** /api/v1/servers | Get servers
[**api_v1_servers_server_id_disks_disk_name_format_post**](DefaultApi.md#api_v1_servers_server_id_disks_disk_name_format_post) | **POST** /api/v1/servers/{serverId}/disks/{diskName}:format | Format disk of a server. Attention: All data will be lost during formatting!
[**api_v1_servers_server_id_disks_disk_name_get**](DefaultApi.md#api_v1_servers_server_id_disks_disk_name_get) | **GET** /api/v1/servers/{serverId}/disks/{diskName} | Get a disk of a server
[**api_v1_servers_server_id_disks_get**](DefaultApi.md#api_v1_servers_server_id_disks_get) | **GET** /api/v1/servers/{serverId}/disks | Get disks of a server
[**api_v1_servers_server_id_disks_patch**](DefaultApi.md#api_v1_servers_server_id_disks_patch) | **PATCH** /api/v1/servers/{serverId}/disks | Patch disk driver of a server.
[**api_v1_servers_server_id_disks_supported_drivers_get**](DefaultApi.md#api_v1_servers_server_id_disks_supported_drivers_get) | **GET** /api/v1/servers/{serverId}/disks/supported-drivers | Get a list of supported storage drivers for this server
[**api_v1_servers_server_id_get**](DefaultApi.md#api_v1_servers_server_id_get) | **GET** /api/v1/servers/{serverId} | Get one server
[**api_v1_servers_server_id_guest_agent_get**](DefaultApi.md#api_v1_servers_server_id_guest_agent_get) | **GET** /api/v1/servers/{serverId}/guest-agent | Get guest agent data for server
[**api_v1_servers_server_id_image_post**](DefaultApi.md#api_v1_servers_server_id_image_post) | **POST** /api/v1/servers/{serverId}/image | Setup image for a server. Attention: All data will be lost during formatting on selected disk!
[**api_v1_servers_server_id_imageflavours_get**](DefaultApi.md#api_v1_servers_server_id_imageflavours_get) | **GET** /api/v1/servers/{serverId}/imageflavours | Get available image flavours for server image setup. Images whose storage driver is not supported by the server's machine type are not shown.
[**api_v1_servers_server_id_interfaces_get**](DefaultApi.md#api_v1_servers_server_id_interfaces_get) | **GET** /api/v1/servers/{serverId}/interfaces | Get all interfaces and IPs of a server including routed IPs and rDNS entries.
[**api_v1_servers_server_id_interfaces_mac_delete**](DefaultApi.md#api_v1_servers_server_id_interfaces_mac_delete) | **DELETE** /api/v1/servers/{serverId}/interfaces/{mac} | Delete an interface of a server.
[**api_v1_servers_server_id_interfaces_mac_firewall_get**](DefaultApi.md#api_v1_servers_server_id_interfaces_mac_firewall_get) | **GET** /api/v1/servers/{serverId}/interfaces/{mac}/firewall | Get firewall
[**api_v1_servers_server_id_interfaces_mac_firewall_put**](DefaultApi.md#api_v1_servers_server_id_interfaces_mac_firewall_put) | **PUT** /api/v1/servers/{serverId}/interfaces/{mac}/firewall | Configure firewall
[**api_v1_servers_server_id_interfaces_mac_firewall_reapply_post**](DefaultApi.md#api_v1_servers_server_id_interfaces_mac_firewall_reapply_post) | **POST** /api/v1/servers/{serverId}/interfaces/{mac}/firewall:reapply | Reapply firewall. Necessary if policy update timed out due to long running write operation on server (f.e. storage optimization)
[**api_v1_servers_server_id_interfaces_mac_firewall_restore_copied_policies_post**](DefaultApi.md#api_v1_servers_server_id_interfaces_mac_firewall_restore_copied_policies_post) | **POST** /api/v1/servers/{serverId}/interfaces/{mac}/firewall:restore-copied-policies | Restore copied firewall policies.
[**api_v1_servers_server_id_interfaces_mac_get**](DefaultApi.md#api_v1_servers_server_id_interfaces_mac_get) | **GET** /api/v1/servers/{serverId}/interfaces/{mac} | Get an interface and IPs of a server including routed IPs and rDNS entries.
[**api_v1_servers_server_id_interfaces_mac_put**](DefaultApi.md#api_v1_servers_server_id_interfaces_mac_put) | **PUT** /api/v1/servers/{serverId}/interfaces/{mac} | Update interface attributes.
[**api_v1_servers_server_id_interfaces_post**](DefaultApi.md#api_v1_servers_server_id_interfaces_post) | **POST** /api/v1/servers/{serverId}/interfaces | Create an interface in a server.
[**api_v1_servers_server_id_iso_delete**](DefaultApi.md#api_v1_servers_server_id_iso_delete) | **DELETE** /api/v1/servers/{serverId}/iso | Detach an ISO from a server.
[**api_v1_servers_server_id_iso_get**](DefaultApi.md#api_v1_servers_server_id_iso_get) | **GET** /api/v1/servers/{serverId}/iso | Get attached ISO of a server.
[**api_v1_servers_server_id_iso_post**](DefaultApi.md#api_v1_servers_server_id_iso_post) | **POST** /api/v1/servers/{serverId}/iso | Attach an ISO to a server.
[**api_v1_servers_server_id_isoimages_get**](DefaultApi.md#api_v1_servers_server_id_isoimages_get) | **GET** /api/v1/servers/{serverId}/isoimages | Get available ISO images for server
[**api_v1_servers_server_id_logs_get**](DefaultApi.md#api_v1_servers_server_id_logs_get) | **GET** /api/v1/servers/{serverId}/logs | Get server logs 
[**api_v1_servers_server_id_metrics_cpu_get**](DefaultApi.md#api_v1_servers_server_id_metrics_cpu_get) | **GET** /api/v1/servers/{serverId}/metrics/cpu | Get CPU metrics of a server.
[**api_v1_servers_server_id_metrics_disk_get**](DefaultApi.md#api_v1_servers_server_id_metrics_disk_get) | **GET** /api/v1/servers/{serverId}/metrics/disk | Get disk metrics of a server.
[**api_v1_servers_server_id_metrics_network_get**](DefaultApi.md#api_v1_servers_server_id_metrics_network_get) | **GET** /api/v1/servers/{serverId}/metrics/network | Get network metrics of a server.
[**api_v1_servers_server_id_metrics_network_packet_get**](DefaultApi.md#api_v1_servers_server_id_metrics_network_packet_get) | **GET** /api/v1/servers/{serverId}/metrics/network/packet | Get network packet metrics of a server.
[**api_v1_servers_server_id_patch**](DefaultApi.md#api_v1_servers_server_id_patch) | **PATCH** /api/v1/servers/{serverId} | Start - stop server or update attributes like hostname, nickname, uefi, bootorder, ...
[**api_v1_servers_server_id_rescuesystem_delete**](DefaultApi.md#api_v1_servers_server_id_rescuesystem_delete) | **DELETE** /api/v1/servers/{serverId}/rescuesystem | Deactivate rescue system for a server.
[**api_v1_servers_server_id_rescuesystem_get**](DefaultApi.md#api_v1_servers_server_id_rescuesystem_get) | **GET** /api/v1/servers/{serverId}/rescuesystem | Get rescue system status for a server.
[**api_v1_servers_server_id_rescuesystem_post**](DefaultApi.md#api_v1_servers_server_id_rescuesystem_post) | **POST** /api/v1/servers/{serverId}/rescuesystem | Activate rescue system for a server.
[**api_v1_servers_server_id_snapshots_dryrun_post**](DefaultApi.md#api_v1_servers_server_id_snapshots_dryrun_post) | **POST** /api/v1/servers/{serverId}/snapshots:dryrun | Check if creating a snapshot is possible.
[**api_v1_servers_server_id_snapshots_get**](DefaultApi.md#api_v1_servers_server_id_snapshots_get) | **GET** /api/v1/servers/{serverId}/snapshots | Get all snapshots of a server.
[**api_v1_servers_server_id_snapshots_name_delete**](DefaultApi.md#api_v1_servers_server_id_snapshots_name_delete) | **DELETE** /api/v1/servers/{serverId}/snapshots/{name} | Delete a snapshot of a server
[**api_v1_servers_server_id_snapshots_name_export_post**](DefaultApi.md#api_v1_servers_server_id_snapshots_name_export_post) | **POST** /api/v1/servers/{serverId}/snapshots/{name}/export | Export a snapshot of a server
[**api_v1_servers_server_id_snapshots_name_get**](DefaultApi.md#api_v1_servers_server_id_snapshots_name_get) | **GET** /api/v1/servers/{serverId}/snapshots/{name} | Get a snapshot of a server.
[**api_v1_servers_server_id_snapshots_name_revert_post**](DefaultApi.md#api_v1_servers_server_id_snapshots_name_revert_post) | **POST** /api/v1/servers/{serverId}/snapshots/{name}/revert | Revert a snapshot of a server
[**api_v1_servers_server_id_snapshots_post**](DefaultApi.md#api_v1_servers_server_id_snapshots_post) | **POST** /api/v1/servers/{serverId}/snapshots | Create a snapshot
[**api_v1_servers_server_id_storageoptimization_post**](DefaultApi.md#api_v1_servers_server_id_storageoptimization_post) | **POST** /api/v1/servers/{serverId}/storageoptimization | Optimize storage of a server.
[**api_v1_servers_server_id_user_image_post**](DefaultApi.md#api_v1_servers_server_id_user_image_post) | **POST** /api/v1/servers/{serverId}/user-image | Setup user image for a server.
[**api_v1_tasks_get**](DefaultApi.md#api_v1_tasks_get) | **GET** /api/v1/tasks | Get all tasks
[**api_v1_tasks_uuid_cancel_put**](DefaultApi.md#api_v1_tasks_uuid_cancel_put) | **PUT** /api/v1/tasks/{uuid}:cancel | Cancel a running task
[**api_v1_tasks_uuid_get**](DefaultApi.md#api_v1_tasks_uuid_get) | **GET** /api/v1/tasks/{uuid} | Get one task
[**api_v1_users_user_id_failoverips_v4_get**](DefaultApi.md#api_v1_users_user_id_failoverips_v4_get) | **GET** /api/v1/users/{userId}/failoverips/v4 | Get all failover IPv4s of this user.
[**api_v1_users_user_id_failoverips_v4_id_patch**](DefaultApi.md#api_v1_users_user_id_failoverips_v4_id_patch) | **PATCH** /api/v1/users/{userId}/failoverips/v4/{id} | Route a failover IPv4.
[**api_v1_users_user_id_failoverips_v6_get**](DefaultApi.md#api_v1_users_user_id_failoverips_v6_get) | **GET** /api/v1/users/{userId}/failoverips/v6 | Get all failover IPv6s of this user.
[**api_v1_users_user_id_failoverips_v6_id_patch**](DefaultApi.md#api_v1_users_user_id_failoverips_v6_id_patch) | **PATCH** /api/v1/users/{userId}/failoverips/v6/{id} | Route a failover IPv6.
[**api_v1_users_user_id_firewall_policies_get**](DefaultApi.md#api_v1_users_user_id_firewall_policies_get) | **GET** /api/v1/users/{userId}/firewall-policies | Get firewall policies
[**api_v1_users_user_id_firewall_policies_id_delete**](DefaultApi.md#api_v1_users_user_id_firewall_policies_id_delete) | **DELETE** /api/v1/users/{userId}/firewall-policies/{id} | Delete firewall policy
[**api_v1_users_user_id_firewall_policies_id_get**](DefaultApi.md#api_v1_users_user_id_firewall_policies_id_get) | **GET** /api/v1/users/{userId}/firewall-policies/{id} | Get firewall policy
[**api_v1_users_user_id_firewall_policies_id_put**](DefaultApi.md#api_v1_users_user_id_firewall_policies_id_put) | **PUT** /api/v1/users/{userId}/firewall-policies/{id} | Update firewall policy
[**api_v1_users_user_id_firewall_policies_post**](DefaultApi.md#api_v1_users_user_id_firewall_policies_post) | **POST** /api/v1/users/{userId}/firewall-policies | Create firewall policy
[**api_v1_users_user_id_get**](DefaultApi.md#api_v1_users_user_id_get) | **GET** /api/v1/users/{userId} | Get one user
[**api_v1_users_user_id_images_get**](DefaultApi.md#api_v1_users_user_id_images_get) | **GET** /api/v1/users/{userId}/images | Get all available user images
[**api_v1_users_user_id_images_key_delete**](DefaultApi.md#api_v1_users_user_id_images_key_delete) | **DELETE** /api/v1/users/{userId}/images/{key} | Delete an image
[**api_v1_users_user_id_images_key_get**](DefaultApi.md#api_v1_users_user_id_images_key_get) | **GET** /api/v1/users/{userId}/images/{key} | Get download informations for an image
[**api_v1_users_user_id_images_key_post**](DefaultApi.md#api_v1_users_user_id_images_key_post) | **POST** /api/v1/users/{userId}/images/{key} | Prepares an upload for an image
[**api_v1_users_user_id_images_key_upload_id_parts_part_number_get**](DefaultApi.md#api_v1_users_user_id_images_key_upload_id_parts_part_number_get) | **GET** /api/v1/users/{userId}/images/{key}/{uploadId}/parts/{partNumber} | Get a presigned upload URL for a single part
[**api_v1_users_user_id_images_key_upload_id_put**](DefaultApi.md#api_v1_users_user_id_images_key_upload_id_put) | **PUT** /api/v1/users/{userId}/images/{key}/{uploadId} | Completes a multipart upload for an image
[**api_v1_users_user_id_isos_get**](DefaultApi.md#api_v1_users_user_id_isos_get) | **GET** /api/v1/users/{userId}/isos | Get all available ISOs
[**api_v1_users_user_id_isos_key_delete**](DefaultApi.md#api_v1_users_user_id_isos_key_delete) | **DELETE** /api/v1/users/{userId}/isos/{key} | Delete an ISO
[**api_v1_users_user_id_isos_key_get**](DefaultApi.md#api_v1_users_user_id_isos_key_get) | **GET** /api/v1/users/{userId}/isos/{key} | Get presigned URL for an ISO
[**api_v1_users_user_id_isos_key_post**](DefaultApi.md#api_v1_users_user_id_isos_key_post) | **POST** /api/v1/users/{userId}/isos/{key} | Prepares an upload for an ISO
[**api_v1_users_user_id_isos_key_upload_id_parts_part_number_get**](DefaultApi.md#api_v1_users_user_id_isos_key_upload_id_parts_part_number_get) | **GET** /api/v1/users/{userId}/isos/{key}/{uploadId}/parts/{partNumber} | Get a presigned upload URL for a single part
[**api_v1_users_user_id_isos_key_upload_id_put**](DefaultApi.md#api_v1_users_user_id_isos_key_upload_id_put) | **PUT** /api/v1/users/{userId}/isos/{key}/{uploadId} | Completes a multipart upload for an ISO
[**api_v1_users_user_id_logs_get**](DefaultApi.md#api_v1_users_user_id_logs_get) | **GET** /api/v1/users/{userId}/logs | Get user logs 
[**api_v1_users_user_id_put**](DefaultApi.md#api_v1_users_user_id_put) | **PUT** /api/v1/users/{userId} | Update a user
[**api_v1_users_user_id_ssh_keys_get**](DefaultApi.md#api_v1_users_user_id_ssh_keys_get) | **GET** /api/v1/users/{userId}/ssh-keys | Get SSH keys
[**api_v1_users_user_id_ssh_keys_id_delete**](DefaultApi.md#api_v1_users_user_id_ssh_keys_id_delete) | **DELETE** /api/v1/users/{userId}/ssh-keys/{id} | Delete SSH key
[**api_v1_users_user_id_ssh_keys_post**](DefaultApi.md#api_v1_users_user_id_ssh_keys_post) | **POST** /api/v1/users/{userId}/ssh-keys | Create SSH key
[**api_v1_users_user_id_vlans_get**](DefaultApi.md#api_v1_users_user_id_vlans_get) | **GET** /api/v1/users/{userId}/vlans | Get VLans of a user
[**api_v1_users_user_id_vlans_vlan_id_get**](DefaultApi.md#api_v1_users_user_id_vlans_vlan_id_get) | **GET** /api/v1/users/{userId}/vlans/{vlanId} | Get a VLan of a user
[**api_v1_users_user_id_vlans_vlan_id_put**](DefaultApi.md#api_v1_users_user_id_vlans_vlan_id_put) | **PUT** /api/v1/users/{userId}/vlans/{vlanId} | Update a VLan
[**api_v1_vlans_vlan_id_get**](DefaultApi.md#api_v1_vlans_vlan_id_get) | **GET** /api/v1/vlans/{vlanId} | Get a VLan



## api_ping_get

> api_ping_get()
Check if application is available

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

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


## api_v1_maintenance_get

> Vec<models::Maintenance> api_v1_maintenance_get()
Get maintenance information for system



### Parameters

This endpoint does not need any parameter.

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_openapi_get

> serde_json::Value api_v1_openapi_get()
Get openapi spec



### Parameters

This endpoint does not need any parameter.

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_rdns_ipv4_ip_delete

> api_v1_rdns_ipv4_ip_delete(ip)
Delete an rDNS entry of an IPv4.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ip** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## api_v1_rdns_ipv4_ip_get

> models::RdnsIpv4 api_v1_rdns_ipv4_ip_get(ip)
Get rDNS for an IPv4.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ip** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_rdns_ipv4_post

> api_v1_rdns_ipv4_post(set_rdns_ipv4)
Set an rDNS entry for an IPv4.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**set_rdns_ipv4** | Option<[**SetRdnsIpv4**](SetRdnsIpv4.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## api_v1_rdns_ipv6_ip_delete

> api_v1_rdns_ipv6_ip_delete(ip)
Delete an rDNS entry of an IPv6.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ip** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## api_v1_rdns_ipv6_ip_get

> models::RdnsIpv6 api_v1_rdns_ipv6_ip_get(ip)
Get rDNS for an IPv6.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ip** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_rdns_ipv6_post

> api_v1_rdns_ipv6_post(set_rdns_ipv6)
Set an rDNS entry for an IPv6.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**set_rdns_ipv6** | Option<[**SetRdnsIpv6**](SetRdnsIpv6.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## api_v1_servers_get

> Vec<models::ServerListMinimal> api_v1_servers_get(ip, limit, name, offset, q)
Get servers



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ip** | Option<**String**> | Filter by ip |  |
**limit** | Option<**i32**> |  |  |
**name** | Option<**String**> | Filter by server name |  |
**offset** | Option<**i32**> |  |  |
**q** | Option<**String**> | Search ignoring case within the property name, nickname, or ipv4Addresses |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_disks_disk_name_format_post

> models::TaskInfo api_v1_servers_server_id_disks_disk_name_format_post(disk_name, server_id)
Format disk of a server. Attention: All data will be lost during formatting!



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**disk_name** | **String** |  | [required] |
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_disks_disk_name_get

> models::Disk api_v1_servers_server_id_disks_disk_name_get(disk_name, server_id)
Get a disk of a server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**disk_name** | **String** |  | [required] |
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_disks_get

> Vec<models::Disk> api_v1_servers_server_id_disks_get(server_id)
Get disks of a server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_disks_patch

> models::TaskInfo api_v1_servers_server_id_disks_patch(server_id, edit_disks_driver)
Patch disk driver of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**edit_disks_driver** | [**EditDisksDriver**](EditDisksDriver.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/merge-patch+json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_disks_supported_drivers_get

> Vec<models::StorageDriver> api_v1_servers_server_id_disks_supported_drivers_get(server_id)
Get a list of supported storage drivers for this server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_get

> models::Server api_v1_servers_server_id_get(server_id, load_server_live_info)
Get one server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**load_server_live_info** | Option<**bool**> |  |  |[default to true]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_guest_agent_get

> models::GuestAgentData api_v1_servers_server_id_guest_agent_get(server_id)
Get guest agent data for server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** | Server id | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_image_post

> models::TaskInfo api_v1_servers_server_id_image_post(server_id, server_image_setup)
Setup image for a server. Attention: All data will be lost during formatting on selected disk!



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**server_image_setup** | Option<[**ServerImageSetup**](ServerImageSetup.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_imageflavours_get

> Vec<models::ImageFlavour> api_v1_servers_server_id_imageflavours_get(server_id)
Get available image flavours for server image setup. Images whose storage driver is not supported by the server's machine type are not shown.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_get

> Vec<models::Interface> api_v1_servers_server_id_interfaces_get(server_id, load_rdns)
Get all interfaces and IPs of a server including routed IPs and rDNS entries.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**load_rdns** | Option<**bool**> |  |  |[default to true]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_mac_delete

> models::TaskInfo api_v1_servers_server_id_interfaces_mac_delete(mac, server_id)
Delete an interface of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**mac** | **String** |  | [required] |
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_mac_firewall_get

> models::ServerFirewall api_v1_servers_server_id_interfaces_mac_firewall_get(server_id, mac, consistency_check)
Get firewall



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**mac** | **String** |  | [required] |
**consistency_check** | Option<**bool**> | Check that the firewall rules have been applied. This will set the consistent attribute to true or false. |  |[default to false]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_mac_firewall_put

> models::TaskInfo api_v1_servers_server_id_interfaces_mac_firewall_put(server_id, mac, server_firewall_save)
Configure firewall



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**mac** | **String** |  | [required] |
**server_firewall_save** | Option<[**ServerFirewallSave**](ServerFirewallSave.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_mac_firewall_reapply_post

> models::TaskInfo api_v1_servers_server_id_interfaces_mac_firewall_reapply_post(server_id, mac)
Reapply firewall. Necessary if policy update timed out due to long running write operation on server (f.e. storage optimization)



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**mac** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_mac_firewall_restore_copied_policies_post

> models::TaskInfo api_v1_servers_server_id_interfaces_mac_firewall_restore_copied_policies_post(server_id, mac)
Restore copied firewall policies.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**mac** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_mac_get

> models::Interface api_v1_servers_server_id_interfaces_mac_get(server_id, mac, load_rdns)
Get an interface and IPs of a server including routed IPs and rDNS entries.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**mac** | **String** |  | [required] |
**load_rdns** | Option<**bool**> |  |  |[default to true]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_mac_put

> models::TaskInfo api_v1_servers_server_id_interfaces_mac_put(server_id, mac, server_interface_update)
Update interface attributes.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**mac** | **String** |  | [required] |
**server_interface_update** | Option<[**ServerInterfaceUpdate**](ServerInterfaceUpdate.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_interfaces_post

> models::TaskInfo api_v1_servers_server_id_interfaces_post(server_id, server_create_nic_vlan)
Create an interface in a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**server_create_nic_vlan** | [**ServerCreateNicVlan**](ServerCreateNicVlan.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/merge-patch+json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_iso_delete

> api_v1_servers_server_id_iso_delete(server_id)
Detach an ISO from a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## api_v1_servers_server_id_iso_get

> models::Iso api_v1_servers_server_id_iso_get(server_id)
Get attached ISO of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_iso_post

> models::TaskInfo api_v1_servers_server_id_iso_post(server_id, server_attach_iso)
Attach an ISO to a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**server_attach_iso** | Option<[**ServerAttachIso**](ServerAttachIso.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_isoimages_get

> Vec<models::IsoImage> api_v1_servers_server_id_isoimages_get(server_id)
Get available ISO images for server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_logs_get

> Vec<models::Log> api_v1_servers_server_id_logs_get(server_id, limit, offset)
Get server logs 



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** | Server id | [required] |
**limit** | Option<**i32**> |  |  |
**offset** | Option<**i32**> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_metrics_cpu_get

> serde_json::Value api_v1_servers_server_id_metrics_cpu_get(server_id, hours)
Get CPU metrics of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**hours** | Option<**i32**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_metrics_disk_get

> serde_json::Value api_v1_servers_server_id_metrics_disk_get(server_id, hours)
Get disk metrics of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**hours** | Option<**i32**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_metrics_network_get

> serde_json::Value api_v1_servers_server_id_metrics_network_get(server_id, hours)
Get network metrics of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**hours** | Option<**i32**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_metrics_network_packet_get

> serde_json::Value api_v1_servers_server_id_metrics_network_packet_get(server_id, hours)
Get network packet metrics of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**hours** | Option<**i32**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_patch

> api_v1_servers_server_id_patch(server_id, api_v1_servers_server_id_patch_request, state_option)
Start - stop server or update attributes like hostname, nickname, uefi, bootorder, ...

Only one attribute at a time.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**api_v1_servers_server_id_patch_request** | [**ApiV1ServersServerIdPatchRequest**](ApiV1ServersServerIdPatchRequest.md) |  | [required] |
**state_option** | Option<**String**> | Only applicable if ServerStatePatch is used. Valid values for state ON: POWERCYCLE, RESET. Valid values for state OFF: POWEROFF. |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/merge-patch+json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_rescuesystem_delete

> models::TaskInfo api_v1_servers_server_id_rescuesystem_delete(server_id)
Deactivate rescue system for a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_rescuesystem_get

> models::RescueSystemStatus api_v1_servers_server_id_rescuesystem_get(server_id)
Get rescue system status for a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_rescuesystem_post

> models::TaskInfo api_v1_servers_server_id_rescuesystem_post(server_id)
Activate rescue system for a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_snapshots_dryrun_post

> Vec<models::ResponseError> api_v1_servers_server_id_snapshots_dryrun_post(server_id, server_snapshot_create_check)
Check if creating a snapshot is possible.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**server_snapshot_create_check** | Option<[**ServerSnapshotCreateCheck**](ServerSnapshotCreateCheck.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_snapshots_get

> Vec<models::SnapshotMinimal> api_v1_servers_server_id_snapshots_get(server_id)
Get all snapshots of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_snapshots_name_delete

> models::TaskInfo api_v1_servers_server_id_snapshots_name_delete(server_id, name)
Delete a snapshot of a server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**name** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_snapshots_name_export_post

> models::TaskInfo api_v1_servers_server_id_snapshots_name_export_post(server_id, name)
Export a snapshot of a server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**name** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_snapshots_name_get

> models::Snapshot api_v1_servers_server_id_snapshots_name_get(server_id, name)
Get a snapshot of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**name** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_snapshots_name_revert_post

> models::TaskInfo api_v1_servers_server_id_snapshots_name_revert_post(server_id, name)
Revert a snapshot of a server



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**name** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_snapshots_post

> models::TaskInfo api_v1_servers_server_id_snapshots_post(server_id, server_snapshot_create)
Create a snapshot



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**server_snapshot_create** | Option<[**ServerSnapshotCreate**](ServerSnapshotCreate.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_storageoptimization_post

> models::TaskInfo api_v1_servers_server_id_storageoptimization_post(server_id, disks, start_after_optimization)
Optimize storage of a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**disks** | Option<[**Vec<String>**](String.md)> |  |  |
**start_after_optimization** | Option<**bool**> |  |  |[default to false]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_servers_server_id_user_image_post

> models::TaskInfo api_v1_servers_server_id_user_image_post(server_id, server_user_image_setup)
Setup user image for a server.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**server_id** | **i32** |  | [required] |
**server_user_image_setup** | Option<[**ServerUserImageSetup**](ServerUserImageSetup.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_tasks_get

> Vec<models::TaskInfoMinimal> api_v1_tasks_get(limit, offset, q, server_id, state)
Get all tasks



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**i32**> |  |  |
**offset** | Option<**i32**> |  |  |
**q** | Option<**String**> | Search ignoring case within the properties name, uuid, server name, server nickname and server uuid |  |
**server_id** | Option<**i32**> |  |  |
**state** | Option<[**TaskState**](.md)> | Filter by state (ROLLBACK is not supported) |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_tasks_uuid_cancel_put

> models::TaskInfo api_v1_tasks_uuid_cancel_put(uuid)
Cancel a running task



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**uuid** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_tasks_uuid_get

> models::TaskInfo api_v1_tasks_uuid_get(uuid)
Get one task



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**uuid** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_failoverips_v4_get

> Vec<models::FailoverIpv4> api_v1_users_user_id_failoverips_v4_get(user_id, ip, server_id)
Get all failover IPv4s of this user.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**ip** | Option<**String**> |  |  |
**server_id** | Option<**i32**> | Filter failover IPv4s of this user by server id |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_failoverips_v4_id_patch

> models::TaskInfo api_v1_users_user_id_failoverips_v4_id_patch(user_id, id, route_failover_ip)
Route a failover IPv4.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**id** | **i32** |  | [required] |
**route_failover_ip** | Option<[**RouteFailoverIp**](RouteFailoverIp.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_failoverips_v6_get

> Vec<models::FailoverIpv6> api_v1_users_user_id_failoverips_v6_get(user_id, ip, server_id)
Get all failover IPv6s of this user.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**ip** | Option<**String**> |  |  |
**server_id** | Option<**i32**> | Filter failover IPv6s of this user by server id |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_failoverips_v6_id_patch

> models::TaskInfo api_v1_users_user_id_failoverips_v6_id_patch(user_id, id, route_failover_ip)
Route a failover IPv6.



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**id** | **i32** |  | [required] |
**route_failover_ip** | Option<[**RouteFailoverIp**](RouteFailoverIp.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_firewall_policies_get

> Vec<models::FirewallPolicy> api_v1_users_user_id_firewall_policies_get(user_id, limit, offset, q)
Get firewall policies



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**limit** | Option<**i32**> |  |  |
**offset** | Option<**i32**> |  |  |
**q** | Option<**String**> | Search by name or description |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_firewall_policies_id_delete

> api_v1_users_user_id_firewall_policies_id_delete(user_id, id)
Delete firewall policy



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**id** | **i32** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_firewall_policies_id_get

> models::FirewallPolicy api_v1_users_user_id_firewall_policies_id_get(user_id, id, with_count_of_affected_servers)
Get firewall policy



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**id** | **i32** |  | [required] |
**with_count_of_affected_servers** | Option<**bool**> |  |  |[default to false]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_firewall_policies_id_put

> models::FirewallPolicyUpdateResult api_v1_users_user_id_firewall_policies_id_put(user_id, id, firewall_policy_save)
Update firewall policy



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**id** | **i32** |  | [required] |
**firewall_policy_save** | Option<[**FirewallPolicySave**](FirewallPolicySave.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_firewall_policies_post

> models::FirewallPolicy api_v1_users_user_id_firewall_policies_post(user_id, firewall_policy_save)
Create firewall policy



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**firewall_policy_save** | Option<[**FirewallPolicySave**](FirewallPolicySave.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_get

> models::User api_v1_users_user_id_get(user_id)
Get one user



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_images_get

> Vec<models::S3Object> api_v1_users_user_id_images_get(user_id)
Get all available user images



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_images_key_delete

> api_v1_users_user_id_images_key_delete(user_id, key)
Delete an image



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## api_v1_users_user_id_images_key_get

> models::S3DownloadInfos api_v1_users_user_id_images_key_get(user_id, key)
Get download informations for an image



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_images_key_post

> models::S3Upload api_v1_users_user_id_images_key_post(user_id, key, multipart)
Prepares an upload for an image

If \"multipart=true\", returns \"uploadId\" that is used to fetch upload URLs for each part with  \"GET /api/v1/users/{userId}/images/{key}/{uploadId}/parts/{partNumber}\". Use this URL to upload individual parts and  get an \"ETag\" for each part. To finish, call \"PUT /api/v1/users/{userId}/images/{key}/{uploadId}\"  with the list of all uploaded parts, containing \"ETag\" and \"partNumber\" for each part. Part numbers start at 1.  If \"multipart=false\", returns \"presignedUrl\" that is used to upload the image at once. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |
**multipart** | Option<**bool**> |  |  |[default to true]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_images_key_upload_id_parts_part_number_get

> models::S3SignPartUrl api_v1_users_user_id_images_key_upload_id_parts_part_number_get(user_id, key, part_number, upload_id)
Get a presigned upload URL for a single part

Call this endpoint for every part. Use the returned URL to upload the part and get an \"ETag\" from the HTTP headers in return. Once all parts are uploaded, call \"PUT /api/v1/users/{userId}/images/{key}/{uploadId}\" with the list of all uploaded parts,  containing \"ETag\" and \"partNumber\" for each part. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |
**part_number** | **i32** |  | [required] |
**upload_id** | **String** |  | [required] |

### Return type

[**models::S3SignPartUrl**](S3SignPartURL.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_images_key_upload_id_put

> api_v1_users_user_id_images_key_upload_id_put(user_id, key, upload_id, s3_completed_part)
Completes a multipart upload for an image

Call this endpoint after uploading all parts. The body must include a list of parts \"ETag\" and \"partNumber\" in order.  This finishes the upload and makes the image available with the provided \"key\". 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |
**upload_id** | **String** |  | [required] |
**s3_completed_part** | Option<[**Vec<models::S3CompletedPart>**](S3CompletedPart.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_isos_get

> Vec<models::S3Object> api_v1_users_user_id_isos_get(user_id)
Get all available ISOs



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_isos_key_delete

> api_v1_users_user_id_isos_key_delete(user_id, key)
Delete an ISO



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## api_v1_users_user_id_isos_key_get

> models::S3DownloadInfos api_v1_users_user_id_isos_key_get(user_id, key)
Get presigned URL for an ISO



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_isos_key_post

> models::S3Upload api_v1_users_user_id_isos_key_post(user_id, key, multipart)
Prepares an upload for an ISO

If \"multipart=true\", returns \"uploadId\" that is used to fetch upload URLs for each part with  \"GET /api/v1/users/{userId}/isos/{key}/{uploadId}/parts/{partNumber}\". Use this URL to upload individual parts and  get an \"ETag\" for each part. To finish, call \"PUT /api/v1/users/{userId}/isos/{key}/{uploadId}\"  with the list of all uploaded parts, containing \"ETag\" and \"partNumber\" for each part. Part numbers start at 1.  If \"multipart=false\", returns \"presignedUrl\" that is used to upload the ISO at once. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |
**multipart** | Option<**bool**> |  |  |[default to true]

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_isos_key_upload_id_parts_part_number_get

> models::S3SignPartUrl api_v1_users_user_id_isos_key_upload_id_parts_part_number_get(user_id, key, part_number, upload_id)
Get a presigned upload URL for a single part

Call this endpoint for every part. Use the returned URL to upload the part and get an \"ETag\" from the HTTP headers in return. Once all parts are uploaded, call \"PUT /api/v1/users/{userId}/isos/{key}/{uploadId}\" with the list of all uploaded parts,  containing \"ETag\" and \"partNumber\" for each part. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |
**part_number** | **i32** |  | [required] |
**upload_id** | **String** |  | [required] |

### Return type

[**models::S3SignPartUrl**](S3SignPartURL.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_isos_key_upload_id_put

> api_v1_users_user_id_isos_key_upload_id_put(user_id, key, upload_id, s3_completed_part)
Completes a multipart upload for an ISO

Call this endpoint after uploading all parts. The body must include a list of parts \"ETag\" and \"partNumber\" in order.  This finishes the upload and makes the ISO available with the provided \"key\". 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**key** | **String** |  | [required] |
**upload_id** | **String** |  | [required] |
**s3_completed_part** | Option<[**Vec<models::S3CompletedPart>**](S3CompletedPart.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_logs_get

> Vec<models::Log> api_v1_users_user_id_logs_get(user_id, limit, offset)
Get user logs 



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** | User id | [required] |
**limit** | Option<**i32**> |  |  |
**offset** | Option<**i32**> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_put

> models::UserSave api_v1_users_user_id_put(user_id, user_save)
Update a user



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**user_save** | Option<[**UserSave**](UserSave.md)> |  |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_ssh_keys_get

> Vec<models::SshKey> api_v1_users_user_id_ssh_keys_get(user_id)
Get SSH keys



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_ssh_keys_id_delete

> api_v1_users_user_id_ssh_keys_id_delete(user_id, id)
Delete SSH key



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**id** | **i32** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_ssh_keys_post

> models::SshKey api_v1_users_user_id_ssh_keys_post(user_id, ssh_key)
Create SSH key



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**ssh_key** | Option<[**SshKey**](SshKey.md)> |  |  |

### Return type

[**models::SshKey**](SSHKey.md)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_vlans_get

> Vec<models::VLan> api_v1_users_user_id_vlans_get(user_id, server_id)
Get VLans of a user



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**server_id** | Option<**i32**> | Filter VLans of a user by server id |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_vlans_vlan_id_get

> models::VLan api_v1_users_user_id_vlans_vlan_id_get(user_id, vlan_id)
Get a VLan of a user



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**vlan_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)


## api_v1_users_user_id_vlans_vlan_id_put

> api_v1_users_user_id_vlans_vlan_id_put(user_id, vlan_id, v_lan_save)
Update a VLan



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**user_id** | **i32** |  | [required] |
**vlan_id** | **i32** |  | [required] |
**v_lan_save** | Option<[**VLanSave**](VLanSave.md)> |  |  |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/hal+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)


## api_v1_vlans_vlan_id_get

> models::VLan api_v1_vlans_vlan_id_get(vlan_id)
Get a VLan



### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**vlan_id** | **i32** |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/hal+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)