tilo/cupcontrol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Init

Browse Source
This commit is contained in:
Tilo Klarenbeek
2025-12-25 13:59:50 +01:00
commit 24611e05c9
206 changed files with 13603 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
scp_core/docs/ApiV1ServersServerIdPatchRequest.md Normal file
View File

@@ -0,0 +1,20 @@
# ApiV1ServersServerIdPatchRequest
## Enum Variants
| Name | Description |
|---- | -----|
| ServerAutostartPatch | |
| ServerBootorderPatch | |
| ServerCpuTopologyPatch | |
| ServerHostnamePatch | |
| ServerKeyboardLayoutPatch | |
| ServerNicknamePatch | |
| ServerOsOptimizationPatch | |
| ServerSetRootPasswordPatch | |
| ServerStatePatch | |
| ServerUefiPatch | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/Architecture.md Normal file
View File

@@ -0,0 +1,13 @@
# Architecture
## Enum Variants
| Name | Value |
|---- | -----|
| Amd64 | AMD64 |
| Arm64 | ARM64 |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/BandwidthClass.md Normal file
View File

@@ -0,0 +1,13 @@
# BandwidthClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | **String** | |
**speed_in_m_bit** | **i32** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/Bootorder.md Normal file
View File

@@ -0,0 +1,14 @@
# Bootorder
## Enum Variants
| Name | Value |
|---- | -----|
| Hdd | HDD |
| Cdrom | CDROM |
| Network | NETWORK |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/CpuTopology.md Normal file
View File

@@ -0,0 +1,12 @@
# CpuTopology
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**socket_count** | Option<**i32**> | | [optional]
**cores_per_socket_count** | Option<**i32**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2691
scp_core/docs/DefaultApi.md Normal file
View File

File diff suppressed because it is too large Load Diff

14
scp_core/docs/Disk.md Normal file
View File

@@ -0,0 +1,14 @@
# Disk
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | | [optional]
**allocation_in_mi_b** | Option<**i64**> | | [optional]
**capacity_in_mi_b** | Option<**i64**> | | [optional]
**storage_driver** | Option<[**models::StorageDriver**](StorageDriver.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/EditDisksDriver.md Normal file
View File

@@ -0,0 +1,11 @@
# EditDisksDriver
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**driver** | [**models::StorageDriver**](StorageDriver.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
scp_core/docs/FailoverIpv4.md Normal file
View File

@@ -0,0 +1,17 @@
# FailoverIpv4
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**ip** | Option<**String**> | | [optional]
**cidr_suffix** | Option<**i32**> | | [optional]
**user** | Option<[**models::UserMinimal**](UserMinimal.md)> | | [optional]
**editable** | Option<**bool**> | | [optional]
**site** | Option<[**models::Site**](Site.md)> | | [optional]
**server** | Option<[**models::ServerMinimal**](ServerMinimal.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
scp_core/docs/FailoverIpv6.md Normal file
View File

@@ -0,0 +1,17 @@
# FailoverIpv6
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**network_prefix** | Option<**String**> | | [optional]
**network_prefix_length** | Option<**i32**> | | [optional]
**user** | Option<[**models::UserMinimal**](UserMinimal.md)> | | [optional]
**editable** | Option<**bool**> | | [optional]
**site** | Option<[**models::Site**](Site.md)> | | [optional]
**server** | Option<[**models::ServerMinimal**](ServerMinimal.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/FieldError.md Normal file
View File

@@ -0,0 +1,12 @@
# FieldError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**field** | Option<**String**> | | [optional]
**message** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/FirewallAction.md Normal file
View File

@@ -0,0 +1,13 @@
# FirewallAction
## Enum Variants
| Name | Value |
|---- | -----|
| Accept | ACCEPT |
| Drop | DROP |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/FirewallPolicy.md Normal file
View File

@@ -0,0 +1,15 @@
# FirewallPolicy
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**rules** | Option<[**Vec<models::FirewallRule>**](FirewallRule.md)> | | [optional]
**count_of_affected_servers** | Option<**i32**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/FirewallPolicySave.md Normal file
View File

@@ -0,0 +1,13 @@
# FirewallPolicySave
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | |
**description** | Option<**String**> | | [optional]
**rules** | Option<[**Vec<models::FirewallRule>**](FirewallRule.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/FirewallPolicyUpdateResult.md Normal file
View File

@@ -0,0 +1,12 @@
# FirewallPolicyUpdateResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**firewall_policy** | Option<[**models::FirewallPolicy**](FirewallPolicy.md)> | | [optional]
**task_info** | Option<[**models::TaskInfo**](TaskInfo.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/FirewallProtocol.md Normal file
View File

@@ -0,0 +1,15 @@
# FirewallProtocol
## Enum Variants
| Name | Value |
|---- | -----|
| Tcp | TCP |
| Udp | UDP |
| Icmp | ICMP |
| Icmpv6 | ICMPv6 |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
scp_core/docs/FirewallRule.md Normal file
View File

@@ -0,0 +1,19 @@
# FirewallRule
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number_of_effective_rules** | Option<**i32**> | | [optional]
**description** | Option<**String**> | | [optional]
**direction** | [**models::FirewallRuleDirection**](FirewallRuleDirection.md) | |
**protocol** | [**models::FirewallProtocol**](FirewallProtocol.md) | |
**action** | [**models::FirewallAction**](FirewallAction.md) | |
**sources** | Option<**Vec<String>**> | Valid configurations are any IP (null or empty array), IPv4/IPv6 address (f.e. 192.168.10.1 or 0092:e10f:cb66:35a9::) or IPv4 network / IPv6 prefix (f.e. 192.168.10.0/24 or 0092:e10f:cb66:35a9::/64). If more than one IP/network is specified for the source, the destination must be empty (any) or contain only a single IP/network. If IPv4 addresses and IPv6 addresses are mixed in sources, destinations must empty (any). | [optional]
**source_ports** | Option<**String**> | Valid configurations are any port (null), single port (f.e. 1234) or port range (f.e. 1024-65535). | [optional]
**destinations** | Option<**Vec<String>**> | Valid configurations are any IP (null or empty array), IPv4/IPv6 address (f.e. 192.168.10.1 or 0092:e10f:cb66:35a9::) or IPv4 network / IPv6 prefix (f.e. 192.168.10.0/24 or 0092:e10f:cb66:35a9::/64). If more than one IP/network is specified for the destination, the source must be empty (any) or contain only a single IP/network. If IPv4 addresses and IPv6 addresses are mixed in destinations, sources must be empty (any). | [optional]
**destination_ports** | Option<**String**> | Valid configurations are any port (null), single port (f.e. 1234) or port range (f.e. 1024-65535). | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/FirewallRuleDirection.md Normal file
View File

@@ -0,0 +1,13 @@
# FirewallRuleDirection
## Enum Variants
| Name | Value |
|---- | -----|
| Ingress | INGRESS |
| Egress | EGRESS |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/GuestAgentData.md Normal file
View File

@@ -0,0 +1,12 @@
# GuestAgentData
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**guest_agent_available** | Option<**bool**> | | [optional]
**guest_agent_data** | Option<[**serde_json::Value**](.md)> | Information in json format about the qemu guest agent, which may change depending on the version. We do not guarantee backwards compatibility for this data. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/IdentifierInt.md Normal file
View File

@@ -0,0 +1,11 @@
# IdentifierInt
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **i32** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/ImageFlavour.md Normal file
View File

@@ -0,0 +1,15 @@
# ImageFlavour
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | **String** | |
**alias** | **String** | |
**text** | **String** | |
**image** | Option<[**models::ImageMinimal**](ImageMinimal.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/ImageMinimal.md Normal file
View File

@@ -0,0 +1,12 @@
# ImageMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/ImplicitRule.md Normal file
View File

@@ -0,0 +1,13 @@
# ImplicitRule
## Enum Variants
| Name | Value |
|---- | -----|
| AcceptAll | ACCEPT_ALL |
| DropAll | DROP_ALL |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/Interface.md Normal file
View File

@@ -0,0 +1,15 @@
# Interface
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mac** | Option<**String**> | | [optional]
**driver** | Option<**String**> | | [optional]
**speed_in_m_bits** | Option<**i32**> | | [optional]
**ipv4_addresses** | Option<[**Vec<models::ServerIpv4>**](ServerIpv4.md)> | | [optional]
**ipv6_addresses** | Option<[**Vec<models::ServerIpv6>**](ServerIpv6.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/Ipv4AddressMinimal.md Normal file
View File

@@ -0,0 +1,15 @@
# Ipv4AddressMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**ip** | Option<**String**> | | [optional]
**netmask** | Option<**String**> | | [optional]
**gateway** | Option<**String**> | | [optional]
**broadcast** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/Ipv6AddressMinimal.md Normal file
View File

@@ -0,0 +1,14 @@
# Ipv6AddressMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**network_prefix** | Option<**String**> | | [optional]
**network_prefix_length** | Option<**i32**> | | [optional]
**gateway** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/Iso.md Normal file
View File

@@ -0,0 +1,12 @@
# Iso
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**iso_attached** | Option<**bool**> | | [optional]
**iso** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/IsoImage.md Normal file
View File

@@ -0,0 +1,14 @@
# IsoImage
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | **String** | |
**description** | Option<**String**> | | [optional]
**architecture** | [**models::Architecture**](Architecture.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/Log.md Normal file
View File

@@ -0,0 +1,15 @@
# Log
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**r#type** | Option<[**models::LogType**](LogType.md)> | | [optional]
**executing_user** | Option<[**models::UserMinimal**](UserMinimal.md)> | | [optional]
**date** | Option<**String**> | | [optional]
**log_key** | Option<**String**> | | [optional]
**message** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/LogType.md Normal file
View File

@@ -0,0 +1,14 @@
# LogType
## Enum Variants
| Name | Value |
|---- | -----|
| Error | ERROR |
| Warning | WARNING |
| Info | INFO |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/Maintenance.md Normal file
View File

@@ -0,0 +1,12 @@
# Maintenance
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_at** | **String** | |
**finish_at** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
scp_core/docs/NetworkDriver.md Normal file
View File

@@ -0,0 +1,16 @@
# NetworkDriver
## Enum Variants
| Name | Value |
|---- | -----|
| Virtio | VIRTIO |
| E1000 | E1000 |
| E1000E | E1000E |
| Rtl8139 | RTL8139 |
| Vmxnet3 | VMXNET3 |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/NotFoundError.md Normal file
View File

@@ -0,0 +1,12 @@
# NotFoundError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | Option<**String**> | | [optional]
**message** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
scp_core/docs/OsOptimization.md Normal file
View File

@@ -0,0 +1,16 @@
# OsOptimization
## Enum Variants
| Name | Value |
|---- | -----|
| Linux | LINUX |
| Windows | WINDOWS |
| Bsd | BSD |
| LinuxLegacy | LINUX_LEGACY |
| Unknown | UNKNOWN |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/RdnsIpv4.md Normal file
View File

@@ -0,0 +1,11 @@
# RdnsIpv4
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rdns** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/RdnsIpv6.md Normal file
View File

@@ -0,0 +1,11 @@
# RdnsIpv6
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rdns** | Option<**std::collections::HashMap<String, String>**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/RescueSystemStatus.md Normal file
View File

@@ -0,0 +1,12 @@
# RescueSystemStatus
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | Option<**bool**> | | [optional]
**password** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/ResponseError.md Normal file
View File

@@ -0,0 +1,12 @@
# ResponseError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | Option<**String**> | | [optional]
**message** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/RouteFailoverIp.md Normal file
View File

@@ -0,0 +1,11 @@
# RouteFailoverIp
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**server_id** | Option<**i32**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/S3CompletedPart.md Normal file
View File

@@ -0,0 +1,12 @@
# S3CompletedPart
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**e_tag** | Option<**String**> | | [optional]
**part_number** | Option<**i32**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/S3DownloadInfos.md Normal file
View File

@@ -0,0 +1,14 @@
# S3DownloadInfos
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filename** | Option<**String**> | | [optional]
**presigned_url** | Option<**String**> | | [optional]
**presigned_url_validity_duration_in_hours** | Option<**i32**> | | [optional]
**headers** | Option<[**std::collections::HashMap<String, Vec<String>>**](Vec.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/S3NoSuchUploadError.md Normal file
View File

@@ -0,0 +1,12 @@
# S3NoSuchUploadError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | Option<**String**> | | [optional]
**message** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/S3Object.md Normal file
View File

@@ -0,0 +1,13 @@
# S3Object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | Option<**String**> | | [optional]
**last_modified** | Option<**String**> | | [optional]
**size_in_b** | Option<**i64**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/S3SignPartUrl.md Normal file
View File

@@ -0,0 +1,11 @@
# S3SignPartUrl
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/S3Upload.md Normal file
View File

@@ -0,0 +1,12 @@
# S3Upload
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**upload_id** | Option<**String**> | | [optional]
**presigned_url** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

26
scp_core/docs/Server.md Normal file
View File

@@ -0,0 +1,26 @@
# Server
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | Option<**String**> | | [optional]
**hostname** | Option<**String**> | | [optional]
**nickname** | Option<**String**> | | [optional]
**disabled** | Option<**bool**> | | [optional]
**template** | Option<[**models::ServerTemplateMinimal**](ServerTemplateMinimal.md)> | | [optional]
**server_live_info** | Option<[**models::ServerInfo**](ServerInfo.md)> | | [optional]
**ipv4_addresses** | Option<[**Vec<models::Ipv4AddressMinimal>**](IPv4AddressMinimal.md)> | | [optional]
**ipv6_addresses** | Option<[**Vec<models::Ipv6AddressMinimal>**](IPv6AddressMinimal.md)> | | [optional]
**site** | Option<[**models::Site**](Site.md)> | | [optional]
**snapshot_count** | Option<**i32**> | | [optional]
**max_cpu_count** | Option<**i32**> | | [optional]
**disks_available_space_in_mi_b** | Option<**i64**> | | [optional]
**rescue_system_active** | Option<**bool**> | | [optional]
**snapshot_allowed** | Option<**bool**> | | [optional]
**architecture** | Option<[**models::Architecture**](Architecture.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/ServerAttachIso.md Normal file
View File

@@ -0,0 +1,13 @@
# ServerAttachIso
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**iso_id** | Option<**i32**> | | [optional]
**user_iso_name** | Option<**String**> | | [optional]
**change_boot_device_to_cdrom** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerAutostartPatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerAutostartPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**autostart** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerBootorderPatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerBootorderPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bootorder** | [**Vec<models::Bootorder>**](Bootorder.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerCpuTopologyPatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerCpuTopologyPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cpu_topology** | Option<[**models::CpuTopology**](CpuTopology.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/ServerCreateNicVlan.md Normal file
View File

@@ -0,0 +1,12 @@
# ServerCreateNicVlan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**vlan_id** | **i32** | |
**network_driver** | [**models::NetworkDriver**](NetworkDriver.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/ServerDisk.md Normal file
View File

@@ -0,0 +1,14 @@
# ServerDisk
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dev** | Option<**String**> | | [optional]
**driver** | Option<**String**> | | [optional]
**capacity_in_mi_b** | Option<**i64**> | | [optional]
**allocation_in_mi_b** | Option<**i64**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/ServerFirewall.md Normal file
View File

@@ -0,0 +1,15 @@
# ServerFirewall
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**copied_policies** | Option<[**Vec<models::FirewallPolicy>**](FirewallPolicy.md)> | | [optional]
**user_policies** | Option<[**Vec<models::FirewallPolicy>**](FirewallPolicy.md)> | | [optional]
**ingress_implicit_rule** | Option<[**models::ImplicitRule**](ImplicitRule.md)> | | [optional]
**egress_implicit_rule** | Option<[**models::ImplicitRule**](ImplicitRule.md)> | | [optional]
**consistent** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/ServerFirewallSave.md Normal file
View File

@@ -0,0 +1,12 @@
# ServerFirewallSave
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**copied_policies** | [**Vec<models::IdentifierInt>**](IdentifierInt.md) | |
**user_policies** | [**Vec<models::IdentifierInt>**](IdentifierInt.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerHostnamePatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerHostnamePatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hostname** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

22
scp_core/docs/ServerImageSetup.md Normal file
View File

@@ -0,0 +1,22 @@
# ServerImageSetup
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**image_flavour_id** | Option<**i32**> | | [optional]
**disk_name** | Option<**String**> | | [optional]
**root_partition_full_disk_size** | Option<**bool**> | | [optional]
**hostname** | Option<**String**> | | [optional]
**locale** | Option<**String**> | | [optional]
**timezone** | Option<**String**> | | [optional]
**additional_user_username** | Option<**String**> | | [optional]
**additional_user_password** | Option<**String**> | | [optional]
**ssh_key_ids** | Option<**Vec<i32>**> | | [optional]
**ssh_password_authentication** | Option<**bool**> | | [optional]
**custom_script** | Option<**String**> | | [optional]
**email_to_executing_user** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

32
scp_core/docs/ServerInfo.md Normal file
View File

@@ -0,0 +1,32 @@
# ServerInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | Option<[**models::ServerState**](ServerState.md)> | | [optional]
**autostart** | Option<**bool**> | | [optional]
**uefi** | Option<**bool**> | | [optional]
**interfaces** | Option<[**Vec<models::ServerInterface>**](ServerInterface.md)> | | [optional]
**disks** | Option<[**Vec<models::ServerDisk>**](ServerDisk.md)> | | [optional]
**bootorder** | Option<[**Vec<models::Bootorder>**](Bootorder.md)> | | [optional]
**required_storage_optimization** | Option<[**models::StorageOptimization**](StorageOptimization.md)> | | [optional]
**template** | Option<**String**> | | [optional]
**uptime_in_seconds** | Option<**i32**> | | [optional]
**current_server_memory_in_mi_b** | Option<**i64**> | | [optional]
**max_server_memory_in_mi_b** | Option<**i64**> | | [optional]
**cpu_count** | Option<**i32**> | | [optional]
**cpu_max_count** | Option<**i32**> | | [optional]
**sockets** | Option<**i32**> | | [optional]
**cores_per_socket** | Option<**i32**> | | [optional]
**latest_qemu** | Option<**bool**> | | [optional]
**config_changed** | Option<**bool**> | | [optional]
**os_optimization** | Option<[**models::OsOptimization**](OsOptimization.md)> | | [optional]
**nested_guest** | Option<**bool**> | | [optional]
**machine_type** | Option<**String**> | | [optional]
**keyboard_layout** | Option<**String**> | | [optional]
**cloudinit_attached** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

22
scp_core/docs/ServerInterface.md Normal file
View File

@@ -0,0 +1,22 @@
# ServerInterface
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mac** | Option<**String**> | | [optional]
**driver** | Option<**String**> | | [optional]
**mtu** | Option<**i32**> | | [optional]
**speed_in_m_bits** | Option<**i32**> | | [optional]
**rx_monthly_in_mi_b** | Option<**i32**> | | [optional]
**tx_monthly_in_mi_b** | Option<**i32**> | | [optional]
**ipv4_addresses** | Option<**Vec<String>**> | | [optional]
**ipv6_link_local_addresses** | Option<**Vec<String>**> | | [optional]
**ipv6_network_prefixes** | Option<**Vec<String>**> | | [optional]
**traffic_throttled** | Option<**bool**> | | [optional]
**vlan_interface** | Option<**bool**> | | [optional]
**vlan_id** | Option<**i32**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerInterfaceUpdate.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerInterfaceUpdate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**driver** | Option<[**models::NetworkDriver**](NetworkDriver.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/ServerIpType.md Normal file
View File

@@ -0,0 +1,13 @@
# ServerIpType
## Enum Variants
| Name | Value |
|---- | -----|
| Ip | IP |
| RoutedIp | ROUTED_IP |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
scp_core/docs/ServerIpv4.md Normal file
View File

@@ -0,0 +1,19 @@
# ServerIpv4
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**interface_mac** | Option<**String**> | | [optional]
**r#type** | Option<[**models::ServerIpType**](ServerIpType.md)> | | [optional]
**ip** | Option<**String**> | | [optional]
**cidr** | Option<**String**> | | [optional]
**gateway** | Option<**String**> | | [optional]
**rdns** | Option<**String**> | | [optional]
**destination_ip** | Option<**String**> | | [optional]
**editable** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

20
scp_core/docs/ServerIpv6.md Normal file
View File

@@ -0,0 +1,20 @@
# ServerIpv6
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**interface_mac** | Option<**String**> | | [optional]
**r#type** | Option<[**models::ServerIpType**](ServerIpType.md)> | | [optional]
**network_prefix** | Option<**String**> | | [optional]
**cidr** | Option<**String**> | | [optional]
**gateway** | Option<**String**> | | [optional]
**link_local** | Option<**bool**> | | [optional]
**rdns** | Option<**std::collections::HashMap<String, String>**> | | [optional]
**destination_ip** | Option<**String**> | | [optional]
**editable** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerKeyboardLayoutPatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerKeyboardLayoutPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**keyboard_layout** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
scp_core/docs/ServerListMinimal.md Normal file
View File

@@ -0,0 +1,16 @@
# ServerListMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | Option<**String**> | | [optional]
**hostname** | Option<**String**> | | [optional]
**nickname** | Option<**String**> | | [optional]
**disabled** | Option<**bool**> | | [optional]
**template** | Option<[**models::ServerTemplateMinimal**](ServerTemplateMinimal.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/ServerMinimal.md Normal file
View File

@@ -0,0 +1,12 @@
# ServerMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerNicknamePatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerNicknamePatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nickname** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerOsOptimizationPatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerOsOptimizationPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**os_optimization** | Option<[**models::OsOptimization**](OsOptimization.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerSetRootPasswordPatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerSetRootPasswordPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**root_password** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/ServerSnapshotCreate.md Normal file
View File

@@ -0,0 +1,14 @@
# ServerSnapshotCreate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | |
**description** | Option<**String**> | | [optional]
**disk_name** | Option<**String**> | | [optional]
**online_snapshot** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/ServerSnapshotCreateCheck.md Normal file
View File

@@ -0,0 +1,12 @@
# ServerSnapshotCreateCheck
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**disk_name** | Option<**String**> | Must be set if attribute onlineSnapshot is false. | [optional]
**online_snapshot** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

20
scp_core/docs/ServerState.md Normal file
View File

@@ -0,0 +1,20 @@
# ServerState
## Enum Variants
| Name | Value |
|---- | -----|
| Nostate | NOSTATE |
| Running | RUNNING |
| Blocked | BLOCKED |
| Paused | PAUSED |
| Shutdown | SHUTDOWN |
| Shutoff | SHUTOFF |
| Crashed | CRASHED |
| Pmsuspended | PMSUSPENDED |
| DiskSnapshot | DISK_SNAPSHOT |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/ServerState1.md Normal file
View File

@@ -0,0 +1,14 @@
# ServerState1
## Enum Variants
| Name | Value |
|---- | -----|
| On | ON |
| Off | OFF |
| Suspended | SUSPENDED |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerStatePatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerStatePatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | Option<[**models::ServerState1**](ServerState1.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/ServerTemplateMinimal.md Normal file
View File

@@ -0,0 +1,12 @@
# ServerTemplateMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/ServerUefiPatch.md Normal file
View File

@@ -0,0 +1,11 @@
# ServerUefiPatch
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uefi** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/ServerUserImageSetup.md Normal file
View File

@@ -0,0 +1,13 @@
# ServerUserImageSetup
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user_image_name** | **String** | |
**disk_name** | Option<**String**> | | [optional]
**email_notification** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/SetRdnsIpv4.md Normal file
View File

@@ -0,0 +1,12 @@
# SetRdnsIpv4
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip** | **String** | |
**rdns** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/SetRdnsIpv6.md Normal file
View File

@@ -0,0 +1,12 @@
# SetRdnsIpv6
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ip** | **String** | |
**rdns** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/Site.md Normal file
View File

@@ -0,0 +1,12 @@
# Site
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**city** | **String** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

20
scp_core/docs/Snapshot.md Normal file
View File

@@ -0,0 +1,20 @@
# Snapshot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**disks** | Option<**Vec<String>**> | | [optional]
**creation_time** | Option<**String**> | | [optional]
**state** | Option<[**models::ServerState**](ServerState.md)> | | [optional]
**online** | Option<**bool**> | | [optional]
**exported** | Option<**bool**> | | [optional]
**exported_size_in_ki_b** | Option<**i64**> | | [optional]
**download_infos** | Option<[**models::S3DownloadInfos**](S3DownloadInfos.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
scp_core/docs/SnapshotMinimal.md Normal file
View File

@@ -0,0 +1,19 @@
# SnapshotMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**description** | Option<**String**> | | [optional]
**disks** | Option<**Vec<String>**> | | [optional]
**creation_time** | Option<**String**> | | [optional]
**state** | Option<[**models::ServerState**](ServerState.md)> | | [optional]
**online** | Option<**bool**> | | [optional]
**exported** | Option<**bool**> | | [optional]
**exported_size_in_ki_b** | Option<**i64**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
scp_core/docs/SshKey.md Normal file
View File

@@ -0,0 +1,14 @@
# SshKey
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**name** | **String** | |
**key** | **String** | |
**created_at** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/StorageDriver.md Normal file
View File

@@ -0,0 +1,15 @@
# StorageDriver
## Enum Variants
| Name | Value |
|---- | -----|
| Virtio | VIRTIO |
| VirtioScsi | VIRTIO_SCSI |
| Ide | IDE |
| Sata | SATA |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
scp_core/docs/StorageOptimization.md Normal file
View File

@@ -0,0 +1,16 @@
# StorageOptimization
## Enum Variants
| Name | Value |
|---- | -----|
| Inconsistent | INCONSISTENT |
| Compat | COMPAT |
| Slow | SLOW |
| Fast | FAST |
| No | NO |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

22
scp_core/docs/TaskInfo.md Normal file
View File

@@ -0,0 +1,22 @@
# TaskInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**state** | Option<[**models::TaskState**](TaskState.md)> | | [optional]
**started_at** | Option<**String**> | | [optional]
**finished_at** | Option<**String**> | | [optional]
**executing_user** | Option<[**models::UserMinimal**](UserMinimal.md)> | | [optional]
**task_progress** | Option<[**models::TaskProgress**](TaskProgress.md)> | | [optional]
**message** | Option<**String**> | | [optional]
**on_rollback** | Option<**bool**> | | [optional]
**steps** | Option<[**Vec<models::TaskInfoStep>**](TaskInfoStep.md)> | | [optional]
**result** | Option<[**serde_json::Value**](.md)> | | [optional]
**response_error** | Option<[**models::ResponseError**](ResponseError.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
scp_core/docs/TaskInfoMinimal.md Normal file
View File

@@ -0,0 +1,19 @@
# TaskInfoMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**state** | Option<[**models::TaskState**](TaskState.md)> | | [optional]
**started_at** | Option<**String**> | | [optional]
**finished_at** | Option<**String**> | | [optional]
**executing_user** | Option<[**models::UserMinimal**](UserMinimal.md)> | | [optional]
**task_progress** | Option<[**models::TaskProgress**](TaskProgress.md)> | | [optional]
**message** | Option<**String**> | | [optional]
**on_rollback** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/TaskInfoStep.md Normal file
View File

@@ -0,0 +1,15 @@
# TaskInfoStep
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | Option<**String**> | | [optional]
**name** | Option<**String**> | | [optional]
**state** | Option<[**models::TaskState**](TaskState.md)> | | [optional]
**started_at** | Option<**String**> | | [optional]
**finished_at** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
scp_core/docs/TaskProgress.md Normal file
View File

@@ -0,0 +1,12 @@
# TaskProgress
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**expected_finished_at** | Option<**String**> | | [optional]
**progress_in_percent** | Option<**f32**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

18
scp_core/docs/TaskState.md Normal file
View File

@@ -0,0 +1,18 @@
# TaskState
## Enum Variants
| Name | Value |
|---- | -----|
| Pending | PENDING |
| Running | RUNNING |
| Finished | FINISHED |
| Error | ERROR |
| WaitingForCancel | WAITING_FOR_CANCEL |
| Canceled | CANCELED |
| Rollback | ROLLBACK |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

23
scp_core/docs/User.md Normal file
View File

@@ -0,0 +1,23 @@
# User
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**username** | Option<**String**> | | [optional]
**firstname** | Option<**String**> | | [optional]
**lastname** | Option<**String**> | | [optional]
**email** | Option<**String**> | | [optional]
**company** | Option<**String**> | | [optional]
**language** | Option<**String**> | | [optional]
**time_zone** | Option<**String**> | | [optional]
**show_nickname** | Option<**bool**> | | [optional]
**passwordless_mode** | Option<**bool**> | | [optional]
**secure_mode** | Option<**bool**> | | [optional]
**secure_mode_app_access** | Option<**bool**> | | [optional]
**api_ip_login_restrictions** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
scp_core/docs/UserMinimal.md Normal file
View File

@@ -0,0 +1,16 @@
# UserMinimal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**username** | Option<**String**> | | [optional]
**firstname** | Option<**String**> | | [optional]
**lastname** | Option<**String**> | | [optional]
**email** | Option<**String**> | | [optional]
**company** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

21
scp_core/docs/UserSave.md Normal file
View File

@@ -0,0 +1,21 @@
# UserSave
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i32**> | | [optional]
**language** | **String** | |
**time_zone** | **String** | |
**api_ip_login_restrictions** | Option<**String**> | | [optional]
**password** | Option<**String**> | | [optional]
**old_password** | Option<**String**> | | [optional]
**soap_webservice_password** | Option<**String**> | | [optional]
**show_nickname** | Option<**bool**> | | [optional]
**passwordless_mode** | Option<**bool**> | | [optional]
**secure_mode** | Option<**bool**> | | [optional]
**secure_mode_app_access** | Option<**bool**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
scp_core/docs/VLan.md Normal file
View File

@@ -0,0 +1,15 @@
# VLan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**vlan_id** | Option<**i32**> | | [optional]
**name** | Option<**String**> | | [optional]
**user** | Option<[**models::UserMinimal**](UserMinimal.md)> | | [optional]
**site** | Option<[**models::Site**](Site.md)> | | [optional]
**bandwidth_class** | Option<[**models::BandwidthClass**](BandwidthClass.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
scp_core/docs/VLanSave.md Normal file
View File

@@ -0,0 +1,11 @@
# VLanSave
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | Option<**String**> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
scp_core/docs/ValidationError.md Normal file
View File

@@ -0,0 +1,13 @@
# ValidationError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | Option<**String**> | | [optional]
**message** | Option<**String**> | | [optional]
**errors** | Option<[**Vec<models::FieldError>**](FieldError.md)> | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)