Rust API client for scp_core
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 2025.1218.164029
- Package version: 0.1.0
- Generator version: 7.18.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named scp_core and add the following to Cargo.toml under [dependencies]:
scp_core = { path = "./scp_core" }
Documentation for API Endpoints
All URIs are relative to https://www.servercontrolpanel.de/scp-core
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | api_ping_get | GET /api/ping | Check if application is available |
| DefaultApi | api_v1_maintenance_get | GET /api/v1/maintenance | Get maintenance information for system |
| DefaultApi | api_v1_openapi_get | GET /api/v1/openapi | Get openapi spec |
| DefaultApi | api_v1_rdns_ipv4_ip_delete | DELETE /api/v1/rdns/ipv4/{ip} | Delete an rDNS entry of an IPv4. |
| DefaultApi | api_v1_rdns_ipv4_ip_get | GET /api/v1/rdns/ipv4/{ip} | Get rDNS for an IPv4. |
| DefaultApi | api_v1_rdns_ipv4_post | POST /api/v1/rdns/ipv4 | Set an rDNS entry for an IPv4. |
| DefaultApi | api_v1_rdns_ipv6_ip_delete | DELETE /api/v1/rdns/ipv6/{ip} | Delete an rDNS entry of an IPv6. |
| DefaultApi | api_v1_rdns_ipv6_ip_get | GET /api/v1/rdns/ipv6/{ip} | Get rDNS for an IPv6. |
| DefaultApi | api_v1_rdns_ipv6_post | POST /api/v1/rdns/ipv6 | Set an rDNS entry for an IPv6. |
| DefaultApi | api_v1_servers_get | GET /api/v1/servers | Get servers |
| DefaultApi | 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! |
| DefaultApi | api_v1_servers_server_id_disks_disk_name_get | GET /api/v1/servers/{serverId}/disks/{diskName} | Get a disk of a server |
| DefaultApi | api_v1_servers_server_id_disks_get | GET /api/v1/servers/{serverId}/disks | Get disks of a server |
| DefaultApi | api_v1_servers_server_id_disks_patch | PATCH /api/v1/servers/{serverId}/disks | Patch disk driver of a server. |
| DefaultApi | 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 |
| DefaultApi | api_v1_servers_server_id_get | GET /api/v1/servers/{serverId} | Get one server |
| DefaultApi | api_v1_servers_server_id_guest_agent_get | GET /api/v1/servers/{serverId}/guest-agent | Get guest agent data for server |
| DefaultApi | 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! |
| DefaultApi | 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. |
| DefaultApi | 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. |
| DefaultApi | api_v1_servers_server_id_interfaces_mac_delete | DELETE /api/v1/servers/{serverId}/interfaces/{mac} | Delete an interface of a server. |
| DefaultApi | api_v1_servers_server_id_interfaces_mac_firewall_get | GET /api/v1/servers/{serverId}/interfaces/{mac}/firewall | Get firewall |
| DefaultApi | api_v1_servers_server_id_interfaces_mac_firewall_put | PUT /api/v1/servers/{serverId}/interfaces/{mac}/firewall | Configure firewall |
| DefaultApi | 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) |
| DefaultApi | 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. |
| DefaultApi | 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. |
| DefaultApi | api_v1_servers_server_id_interfaces_mac_put | PUT /api/v1/servers/{serverId}/interfaces/{mac} | Update interface attributes. |
| DefaultApi | api_v1_servers_server_id_interfaces_post | POST /api/v1/servers/{serverId}/interfaces | Create an interface in a server. |
| DefaultApi | api_v1_servers_server_id_iso_delete | DELETE /api/v1/servers/{serverId}/iso | Detach an ISO from a server. |
| DefaultApi | api_v1_servers_server_id_iso_get | GET /api/v1/servers/{serverId}/iso | Get attached ISO of a server. |
| DefaultApi | api_v1_servers_server_id_iso_post | POST /api/v1/servers/{serverId}/iso | Attach an ISO to a server. |
| DefaultApi | api_v1_servers_server_id_isoimages_get | GET /api/v1/servers/{serverId}/isoimages | Get available ISO images for server |
| DefaultApi | api_v1_servers_server_id_logs_get | GET /api/v1/servers/{serverId}/logs | Get server logs |
| DefaultApi | api_v1_servers_server_id_metrics_cpu_get | GET /api/v1/servers/{serverId}/metrics/cpu | Get CPU metrics of a server. |
| DefaultApi | api_v1_servers_server_id_metrics_disk_get | GET /api/v1/servers/{serverId}/metrics/disk | Get disk metrics of a server. |
| DefaultApi | api_v1_servers_server_id_metrics_network_get | GET /api/v1/servers/{serverId}/metrics/network | Get network metrics of a server. |
| DefaultApi | api_v1_servers_server_id_metrics_network_packet_get | GET /api/v1/servers/{serverId}/metrics/network/packet | Get network packet metrics of a server. |
| DefaultApi | api_v1_servers_server_id_patch | PATCH /api/v1/servers/{serverId} | Start - stop server or update attributes like hostname, nickname, uefi, bootorder, ... |
| DefaultApi | api_v1_servers_server_id_rescuesystem_delete | DELETE /api/v1/servers/{serverId}/rescuesystem | Deactivate rescue system for a server. |
| DefaultApi | api_v1_servers_server_id_rescuesystem_get | GET /api/v1/servers/{serverId}/rescuesystem | Get rescue system status for a server. |
| DefaultApi | api_v1_servers_server_id_rescuesystem_post | POST /api/v1/servers/{serverId}/rescuesystem | Activate rescue system for a server. |
| DefaultApi | api_v1_servers_server_id_snapshots_dryrun_post | POST /api/v1/servers/{serverId}/snapshots:dryrun | Check if creating a snapshot is possible. |
| DefaultApi | api_v1_servers_server_id_snapshots_get | GET /api/v1/servers/{serverId}/snapshots | Get all snapshots of a server. |
| DefaultApi | api_v1_servers_server_id_snapshots_name_delete | DELETE /api/v1/servers/{serverId}/snapshots/{name} | Delete a snapshot of a server |
| DefaultApi | api_v1_servers_server_id_snapshots_name_export_post | POST /api/v1/servers/{serverId}/snapshots/{name}/export | Export a snapshot of a server |
| DefaultApi | api_v1_servers_server_id_snapshots_name_get | GET /api/v1/servers/{serverId}/snapshots/{name} | Get a snapshot of a server. |
| DefaultApi | api_v1_servers_server_id_snapshots_name_revert_post | POST /api/v1/servers/{serverId}/snapshots/{name}/revert | Revert a snapshot of a server |
| DefaultApi | api_v1_servers_server_id_snapshots_post | POST /api/v1/servers/{serverId}/snapshots | Create a snapshot |
| DefaultApi | api_v1_servers_server_id_storageoptimization_post | POST /api/v1/servers/{serverId}/storageoptimization | Optimize storage of a server. |
| DefaultApi | api_v1_servers_server_id_user_image_post | POST /api/v1/servers/{serverId}/user-image | Setup user image for a server. |
| DefaultApi | api_v1_tasks_get | GET /api/v1/tasks | Get all tasks |
| DefaultApi | api_v1_tasks_uuid_cancel_put | PUT /api/v1/tasks/{uuid}:cancel | Cancel a running task |
| DefaultApi | api_v1_tasks_uuid_get | GET /api/v1/tasks/{uuid} | Get one task |
| DefaultApi | api_v1_users_user_id_failoverips_v4_get | GET /api/v1/users/{userId}/failoverips/v4 | Get all failover IPv4s of this user. |
| DefaultApi | api_v1_users_user_id_failoverips_v4_id_patch | PATCH /api/v1/users/{userId}/failoverips/v4/{id} | Route a failover IPv4. |
| DefaultApi | api_v1_users_user_id_failoverips_v6_get | GET /api/v1/users/{userId}/failoverips/v6 | Get all failover IPv6s of this user. |
| DefaultApi | api_v1_users_user_id_failoverips_v6_id_patch | PATCH /api/v1/users/{userId}/failoverips/v6/{id} | Route a failover IPv6. |
| DefaultApi | api_v1_users_user_id_firewall_policies_get | GET /api/v1/users/{userId}/firewall-policies | Get firewall policies |
| DefaultApi | api_v1_users_user_id_firewall_policies_id_delete | DELETE /api/v1/users/{userId}/firewall-policies/{id} | Delete firewall policy |
| DefaultApi | api_v1_users_user_id_firewall_policies_id_get | GET /api/v1/users/{userId}/firewall-policies/{id} | Get firewall policy |
| DefaultApi | api_v1_users_user_id_firewall_policies_id_put | PUT /api/v1/users/{userId}/firewall-policies/{id} | Update firewall policy |
| DefaultApi | api_v1_users_user_id_firewall_policies_post | POST /api/v1/users/{userId}/firewall-policies | Create firewall policy |
| DefaultApi | api_v1_users_user_id_get | GET /api/v1/users/{userId} | Get one user |
| DefaultApi | api_v1_users_user_id_images_get | GET /api/v1/users/{userId}/images | Get all available user images |
| DefaultApi | api_v1_users_user_id_images_key_delete | DELETE /api/v1/users/{userId}/images/{key} | Delete an image |
| DefaultApi | api_v1_users_user_id_images_key_get | GET /api/v1/users/{userId}/images/{key} | Get download informations for an image |
| DefaultApi | api_v1_users_user_id_images_key_post | POST /api/v1/users/{userId}/images/{key} | Prepares an upload for an image |
| DefaultApi | 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 |
| DefaultApi | 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 |
| DefaultApi | api_v1_users_user_id_isos_get | GET /api/v1/users/{userId}/isos | Get all available ISOs |
| DefaultApi | api_v1_users_user_id_isos_key_delete | DELETE /api/v1/users/{userId}/isos/{key} | Delete an ISO |
| DefaultApi | api_v1_users_user_id_isos_key_get | GET /api/v1/users/{userId}/isos/{key} | Get presigned URL for an ISO |
| DefaultApi | api_v1_users_user_id_isos_key_post | POST /api/v1/users/{userId}/isos/{key} | Prepares an upload for an ISO |
| DefaultApi | 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 |
| DefaultApi | 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 |
| DefaultApi | api_v1_users_user_id_logs_get | GET /api/v1/users/{userId}/logs | Get user logs |
| DefaultApi | api_v1_users_user_id_put | PUT /api/v1/users/{userId} | Update a user |
| DefaultApi | api_v1_users_user_id_ssh_keys_get | GET /api/v1/users/{userId}/ssh-keys | Get SSH keys |
| DefaultApi | api_v1_users_user_id_ssh_keys_id_delete | DELETE /api/v1/users/{userId}/ssh-keys/{id} | Delete SSH key |
| DefaultApi | api_v1_users_user_id_ssh_keys_post | POST /api/v1/users/{userId}/ssh-keys | Create SSH key |
| DefaultApi | api_v1_users_user_id_vlans_get | GET /api/v1/users/{userId}/vlans | Get VLans of a user |
| DefaultApi | api_v1_users_user_id_vlans_vlan_id_get | GET /api/v1/users/{userId}/vlans/{vlanId} | Get a VLan of a user |
| DefaultApi | api_v1_users_user_id_vlans_vlan_id_put | PUT /api/v1/users/{userId}/vlans/{vlanId} | Update a VLan |
| DefaultApi | api_v1_vlans_vlan_id_get | GET /api/v1/vlans/{vlanId} | Get a VLan |
Documentation For Models
- ApiV1ServersServerIdPatchRequest
- Architecture
- BandwidthClass
- Bootorder
- CpuTopology
- Disk
- EditDisksDriver
- FailoverIpv4
- FailoverIpv6
- FieldError
- FirewallAction
- FirewallPolicy
- FirewallPolicySave
- FirewallPolicyUpdateResult
- FirewallProtocol
- FirewallRule
- FirewallRuleDirection
- GuestAgentData
- IdentifierInt
- ImageFlavour
- ImageMinimal
- ImplicitRule
- Interface
- Ipv4AddressMinimal
- Ipv6AddressMinimal
- Iso
- IsoImage
- Log
- LogType
- Maintenance
- NetworkDriver
- NotFoundError
- OsOptimization
- RdnsIpv4
- RdnsIpv6
- RescueSystemStatus
- ResponseError
- RouteFailoverIp
- S3CompletedPart
- S3DownloadInfos
- S3NoSuchUploadError
- S3Object
- S3SignPartUrl
- S3Upload
- Server
- ServerAttachIso
- ServerAutostartPatch
- ServerBootorderPatch
- ServerCpuTopologyPatch
- ServerCreateNicVlan
- ServerDisk
- ServerFirewall
- ServerFirewallSave
- ServerHostnamePatch
- ServerImageSetup
- ServerInfo
- ServerInterface
- ServerInterfaceUpdate
- ServerIpType
- ServerIpv4
- ServerIpv6
- ServerKeyboardLayoutPatch
- ServerListMinimal
- ServerMinimal
- ServerNicknamePatch
- ServerOsOptimizationPatch
- ServerSetRootPasswordPatch
- ServerSnapshotCreate
- ServerSnapshotCreateCheck
- ServerState
- ServerState1
- ServerStatePatch
- ServerTemplateMinimal
- ServerUefiPatch
- ServerUserImageSetup
- SetRdnsIpv4
- SetRdnsIpv6
- Site
- Snapshot
- SnapshotMinimal
- SshKey
- StorageDriver
- StorageOptimization
- TaskInfo
- TaskInfoMinimal
- TaskInfoStep
- TaskProgress
- TaskState
- User
- UserMinimal
- UserSave
- VLan
- VLanSave
- ValidationError
To get access to the crate's generated documentation, use:
cargo doc --open