Notes
This Scaleway API Crate is created and maintained by Qovery and used in production in the Qovery Engine.
This project relies on OpenAPI Generator, refers to UPDATE.md to update generated code.
Rust API client for scaleway_api_rs
Introduction
Elastic metal as a service allows ordering a dedicated server on-demand like a cloud instance. Dedicated servers could be used for large workloads, big data, those requiring more security, ….
Technical Limitations
-
Elastic metal is available in
fr-par-1
,fr-par-2
,nl-ams-1
zones -
Installation is done by preseed (± 10min) (preseed: complete install from a virtual media)
Features
-
Install (Server is installed by preseed (preseed: complete install from a virtual media), you must define at least one ssh key to install your server)
-
Start/Stop/Reboot
-
Rescue Reboot, a rescue image is an operating system image designed to help you diagnose and fix an OS experiencing failures. When your server boot on rescue, you can mount your disks and start diagnosing/fixing your image.
-
Billed by minute (The billing start when the server is delivered and stop when the server is deleted)
-
IPv6, all servers are available with an IPv6 /128
-
ReverseIP, You can configure your reverse IP (IPv4 and IPv6), you must register the server IP in your DNS records before calling the endpoint
-
Basic monitoring with ping status
-
Flexible IP is available (documentation)
-
IP failovers are not available in api v1, use the api v1alpha1
FAQ
How can I get my SSH key id?
You can find your $SCW_SECRET_KEY
and your SCW_DEFAULT_ORGANIZATION_ID
at the following page: https://console.scaleway.com/project/credentials
How can I add my server to a private network?
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: v1
- Package version: 0.2.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named scaleway_api_rs
and add the following to Cargo.toml
under [dependencies]
:
scaleway_api_rs = { path = "./scaleway_api_rs" }
Documentation for API Endpoints
All URIs are relative to https://api.scaleway.com
Class | Method | HTTP request | Description |
---|---|---|---|
ACLApi | add_instance_acl_rules | POST /rdb/v1/regions/{region}/instances/{instance_id}/acls | Add an ACL instance to a given instance |
ACLApi | delete_instance_acl_rules | DELETE /rdb/v1/regions/{region}/instances/{instance_id}/acls | Delete ACL rules of a given instance |
ACLApi | list_instance_acl_rules | GET /rdb/v1/regions/{region}/instances/{instance_id}/acls | List ACL rules of a given instance |
ACLApi | set_instance_acl_rules | PUT /rdb/v1/regions/{region}/instances/{instance_id}/acls | Set ACL rules for a given instance |
BMCAccessApi | get_bmc_access | GET /baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access | Get BMC (Baseboard Management Controller) access for a given elastic metal server |
BMCAccessApi | start_bmc_access | POST /baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access | Start BMC (Baseboard Management Controller) access for a given elastic metal server |
BMCAccessApi | stop_bmc_access | DELETE /baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access | Stop BMC (Baseboard Management Controller) access for a given elastic metal server |
BackupsApi | create_database_backup | POST /rdb/v1/regions/{region}/backups | Create a database backup |
BackupsApi | delete_database_backup | DELETE /rdb/v1/regions/{region}/backups/{database_backup_id} | Delete a database backup |
BackupsApi | export_database_backup | POST /rdb/v1/regions/{region}/backups/{database_backup_id}/export | Export a database backup |
BackupsApi | get_database_backup | GET /rdb/v1/regions/{region}/backups/{database_backup_id} | Get a database backup |
BackupsApi | list_database_backups | GET /rdb/v1/regions/{region}/backups | List database backups |
BackupsApi | restore_database_backup | POST /rdb/v1/regions/{region}/backups/{database_backup_id}/restore | Restore a database backup |
BackupsApi | update_database_backup | PATCH /rdb/v1/regions/{region}/backups/{database_backup_id} | Update a database backup |
ClustersApi | create_cluster | POST /k8s/v1/regions/{region}/clusters | Create a new cluster |
ClustersApi | delete_cluster | DELETE /k8s/v1/regions/{region}/clusters/{cluster_id} | Delete a cluster |
ClustersApi | get_cluster | GET /k8s/v1/regions/{region}/clusters/{cluster_id} | Get a cluster |
ClustersApi | get_cluster_kube_config | GET /k8s/v1/regions/{region}/clusters/{cluster_id}/kubeconfig | Download the kubeconfig for a cluster |
ClustersApi | list_cluster_available_versions | GET /k8s/v1/regions/{region}/clusters/{cluster_id}/available-versions | List available versions for a cluster |
ClustersApi | list_clusters | GET /k8s/v1/regions/{region}/clusters | List all the clusters |
ClustersApi | reset_cluster_admin_token | POST /k8s/v1/regions/{region}/clusters/{cluster_id}/reset-admin-token | Reset the admin token of a cluster |
ClustersApi | update_cluster | PATCH /k8s/v1/regions/{region}/clusters/{cluster_id} | Update a cluster |
ClustersApi | upgrade_cluster | POST /k8s/v1/regions/{region}/clusters/{cluster_id}/upgrade | Upgrade a cluster |
DNSZonesApi | clone_dns_zone | POST /domain/v2beta1/dns-zones/{dns_zone}/clone | Clone a DNS zone |
DNSZonesApi | create_dns_zone | POST /domain/v2beta1/dns-zones | Create a DNS zone |
DNSZonesApi | create_ssl_certificate | POST /domain/v2beta1/ssl-certificates | Create or return the zone TLS certificate |
DNSZonesApi | delete_dns_zone | DELETE /domain/v2beta1/dns-zones/{dns_zone} | Delete DNS zone |
DNSZonesApi | delete_dns_zone_tsig_key | DELETE /domain/v2beta1/dns-zones/{dns_zone}/tsig-key | Delete the DNS zone TSIG Key |
DNSZonesApi | delete_ssl_certificate | DELETE /domain/v2beta1/ssl-certificates/{dns_zone} | Delete an TLS certificate |
DNSZonesApi | get_dns_zone_tsig_key | GET /domain/v2beta1/dns-zones/{dns_zone}/tsig-key | Get the DNS zone TSIG Key |
DNSZonesApi | get_ssl_certificate | GET /domain/v2beta1/ssl-certificates/{dns_zone} | Get the zone TLS certificate if it exists |
DNSZonesApi | list_dns_zones | GET /domain/v2beta1/dns-zones | List DNS zones |
DNSZonesApi | list_ssl_certificates | GET /domain/v2beta1/ssl-certificates | List all user TLS certificates |
DNSZonesApi | refresh_dns_zone | POST /domain/v2beta1/dns-zones/{dns_zone}/refresh | Refresh DNS zone |
DNSZonesApi | update_dns_zone | PATCH /domain/v2beta1/dns-zones/{dns_zone} | Update a DNS zone |
DatabaseInstancesApi | clone_instance | POST /rdb/v1/regions/{region}/instances/{instance_id}/clone | Clone an instance |
DatabaseInstancesApi | create_instance | POST /rdb/v1/regions/{region}/instances | Create an instance |
DatabaseInstancesApi | delete_instance | DELETE /rdb/v1/regions/{region}/instances/{instance_id} | Delete an instance |
DatabaseInstancesApi | get_instance | GET /rdb/v1/regions/{region}/instances/{instance_id} | Get an instance |
DatabaseInstancesApi | get_instance_certificate | GET /rdb/v1/regions/{region}/instances/{instance_id}/certificate | Get the TLS certificate of an instance |
DatabaseInstancesApi | get_instance_log | GET /rdb/v1/regions/{region}/logs/{instance_log_id} | Get specific logs of a given instance |
DatabaseInstancesApi | get_instance_metrics | GET /rdb/v1/regions/{region}/instances/{instance_id}/metrics | Get instance metrics |
DatabaseInstancesApi | list_instance_logs | GET /rdb/v1/regions/{region}/instances/{instance_id}/logs | List available logs of a given instance |
DatabaseInstancesApi | list_instance_logs_details | GET /rdb/v1/regions/{region}/instances/{instance_id}/logs-details | List remote instances logs details |
DatabaseInstancesApi | list_instances | GET /rdb/v1/regions/{region}/instances | List instances |
DatabaseInstancesApi | prepare_instance_logs | POST /rdb/v1/regions/{region}/instances/{instance_id}/prepare-logs | Prepare logs of a given instance |
DatabaseInstancesApi | purge_instance_logs | POST /rdb/v1/regions/{region}/instances/{instance_id}/purge-logs | Purge remote instances logs |
DatabaseInstancesApi | renew_instance_certificate | POST /rdb/v1/regions/{region}/instances/{instance_id}/renew-certificate | Renew the TLS certificate of an instance |
DatabaseInstancesApi | restart_instance | POST /rdb/v1/regions/{region}/instances/{instance_id}/restart | Restart an instance |
DatabaseInstancesApi | update_instance | PATCH /rdb/v1/regions/{region}/instances/{instance_id} | Update an instance |
DatabaseInstancesApi | upgrade_instance | POST /rdb/v1/regions/{region}/instances/{instance_id}/upgrade | Upgrade an instance to an higher instance type |
DatabasesApi | create_database | POST /rdb/v1/regions/{region}/instances/{instance_id}/databases | Create a database in a given instance |
DatabasesApi | delete_database | DELETE /rdb/v1/regions/{region}/instances/{instance_id}/databases/{name} | Delete a database in a given instance |
DatabasesApi | list_databases | GET /rdb/v1/regions/{region}/instances/{instance_id}/databases | List all database in a given instance |
DefaultApi | move_mac_addr | POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/move | |
EndpointsApi | create_endpoint | POST /rdb/v1/regions/{region}/instances/{instance_id}/endpoints | Create a new instance endpoint |
EndpointsApi | delete_endpoint | DELETE /rdb/v1/regions/{region}/endpoints/{endpoint_id} | Delete an instance endpoint |
EndpointsApi | get_endpoint | GET /rdb/v1/regions/{region}/endpoints/{endpoint_id} | Get an instance endpoint |
EnginesApi | list_database_engines | GET /rdb/v1/regions/{region}/database-engines | List available database engines |
FlexibleIPApi | attach_flexible_ip | POST /flexible-ip/v1alpha1/zones/{zone}/fips/attach | Attach a Flexible IP to a server |
FlexibleIPApi | create_flexible_ip | POST /flexible-ip/v1alpha1/zones/{zone}/fips | Create a Flexible IP |
FlexibleIPApi | delete_flexible_ip | DELETE /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id} | Delete a Flexible IP |
FlexibleIPApi | delete_mac_addr | DELETE /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac | Remove a virtual MAC from a Flexible IP |
FlexibleIPApi | detach_flexible_ip | POST /flexible-ip/v1alpha1/zones/{zone}/fips/detach | Detach a Flexible IP from a server |
FlexibleIPApi | duplicate_mac_addr | POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/duplicate | Duplicate a Virtual MAC |
FlexibleIPApi | generate_mac_addr | POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac | Generate a virtual MAC on a given Flexible IP |
FlexibleIPApi | get_flexible_ip | GET /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id} | Get a Flexible IP |
FlexibleIPApi | list_flexible_ips | GET /flexible-ip/v1alpha1/zones/{zone}/fips | List Flexible IPs |
FlexibleIPApi | update_flexible_ip | PATCH /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id} | Update a Flexible IP |
ImagesApi | delete_image | DELETE /registry/v1/regions/{region}/images/{image_id} | Delete an image |
ImagesApi | get_image | GET /registry/v1/regions/{region}/images/{image_id} | Get a image |
ImagesApi | list_images | GET /registry/v1/regions/{region}/images | List all your images |
ImagesApi | update_image | PATCH /registry/v1/regions/{region}/images/{image_id} | Update an existing image |
ImportsExportsApi | export_raw_dns_zone | GET /domain/v2beta1/dns-zones/{dns_zone}/raw | Export raw DNS zone |
ImportsExportsApi | import_provider_dns_zone | POST /domain/v2beta1/dns-zones/{dns_zone}/import-provider | Import provider DNS zone |
ImportsExportsApi | import_raw_dns_zone | POST /domain/v2beta1/dns-zones/{dns_zone}/raw | Import raw DNS zone |
InstanceSettingsApi | add_instance_settings | POST /rdb/v1/regions/{region}/instances/{instance_id}/settings | Add an instance setting |
InstanceSettingsApi | delete_instance_settings | DELETE /rdb/v1/regions/{region}/instances/{instance_id}/settings | Delete an instance setting |
InstanceSettingsApi | set_instance_settings | PUT /rdb/v1/regions/{region}/instances/{instance_id}/settings | Set a given instance setting |
IoTCloudTwinsApi | delete_twin_document | DELETE /iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name} | BETA - Delete a Cloud Twin Document |
IoTCloudTwinsApi | delete_twin_documents | DELETE /iot/v1/regions/{region}/twins/{twin_id} | BETA - Delete all the documents of a Cloud Twin |
IoTCloudTwinsApi | get_twin_document | GET /iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name} | BETA - Get a Cloud Twin Document |
IoTCloudTwinsApi | list_twin_documents | GET /iot/v1/regions/{region}/twins/{twin_id} | BETA - List the documents of a Cloud Twin |
IoTCloudTwinsApi | patch_twin_document | PATCH /iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name} | BETA - Patch a Cloud Twin Document |
IoTCloudTwinsApi | put_twin_document | PUT /iot/v1/regions/{region}/twins/{twin_id}/documents/{document_name} | BETA - Update a Cloud Twin Document |
IoTDevicesApi | create_device | POST /iot/v1/regions/{region}/devices | Add a device |
IoTDevicesApi | delete_device | DELETE /iot/v1/regions/{region}/devices/{device_id} | Remove a device |
IoTDevicesApi | disable_device | POST /iot/v1/regions/{region}/devices/{device_id}/disable | Disable a device |
IoTDevicesApi | enable_device | POST /iot/v1/regions/{region}/devices/{device_id}/enable | Enable a device |
IoTDevicesApi | get_device | GET /iot/v1/regions/{region}/devices/{device_id} | Get a device |
IoTDevicesApi | get_device_certificate | GET /iot/v1/regions/{region}/devices/{device_id}/certificate | Get a device's certificate |
IoTDevicesApi | get_device_metrics | GET /iot/v1/regions/{region}/devices/{device_id}/metrics | Get a device's metrics |
IoTDevicesApi | list_devices | GET /iot/v1/regions/{region}/devices | List devices |
IoTDevicesApi | renew_device_certificate | POST /iot/v1/regions/{region}/devices/{device_id}/renew-certificate | Renew a device certificate |
IoTDevicesApi | set_device_certificate | PUT /iot/v1/regions/{region}/devices/{device_id}/certificate | Set a custom certificate on a device |
IoTDevicesApi | update_device | PATCH /iot/v1/regions/{region}/devices/{device_id} | Update a device |
IoTHubsApi | create_hub | POST /iot/v1/regions/{region}/hubs | Create a hub |
IoTHubsApi | delete_hub | DELETE /iot/v1/regions/{region}/hubs/{hub_id} | Delete a hub |
IoTHubsApi | disable_hub | POST /iot/v1/regions/{region}/hubs/{hub_id}/disable | Disable a hub |
IoTHubsApi | enable_hub | POST /iot/v1/regions/{region}/hubs/{hub_id}/enable | Enable a hub |
IoTHubsApi | get_hub | GET /iot/v1/regions/{region}/hubs/{hub_id} | Get a hub |
IoTHubsApi | get_hub_ca | GET /iot/v1/regions/{region}/hubs/{hub_id}/ca | Get the certificate authority of a hub |
IoTHubsApi | get_hub_metrics | GET /iot/v1/regions/{region}/hubs/{hub_id}/metrics | Get a hub's metrics |
IoTHubsApi | list_hubs | GET /iot/v1/regions/{region}/hubs | List hubs |
IoTHubsApi | set_hub_ca | POST /iot/v1/regions/{region}/hubs/{hub_id}/ca | Set the certificate authority of a hub |
IoTHubsApi | update_hub | PATCH /iot/v1/regions/{region}/hubs/{hub_id} | Update a hub |
IoTNetworksApi | create_network | POST /iot/v1/regions/{region}/networks | Create a new Network |
IoTNetworksApi | delete_network | DELETE /iot/v1/regions/{region}/networks/{network_id} | Delete a Network |
IoTNetworksApi | get_network | GET /iot/v1/regions/{region}/networks/{network_id} | Retrieve a specific Network |
IoTNetworksApi | list_networks | GET /iot/v1/regions/{region}/networks | List the Networks |
IoTRoutesApi | create_route | POST /iot/v1/regions/{region}/routes | Create a route |
IoTRoutesApi | delete_route | DELETE /iot/v1/regions/{region}/routes/{route_id} | Delete a route |
IoTRoutesApi | get_route | GET /iot/v1/regions/{region}/routes/{route_id} | Get a route |
IoTRoutesApi | list_routes | GET /iot/v1/regions/{region}/routes | List routes |
IoTRoutesApi | update_route | PATCH /iot/v1/regions/{region}/routes/{route_id} | Update a route |
NamespacesApi | create_namespace | POST /registry/v1/regions/{region}/namespaces | Create a new namespace |
NamespacesApi | delete_namespace | DELETE /registry/v1/regions/{region}/namespaces/{namespace_id} | Delete an existing namespace |
NamespacesApi | get_namespace | GET /registry/v1/regions/{region}/namespaces/{namespace_id} | Get a namespace |
NamespacesApi | list_namespaces | GET /registry/v1/regions/{region}/namespaces | List all your namespaces |
NamespacesApi | update_namespace | PATCH /registry/v1/regions/{region}/namespaces/{namespace_id} | Update an existing namespace |
NodeTypesApi | list_node_types | GET /rdb/v1/regions/{region}/node-types | List available node types |
NodesApi | get_node | GET /k8s/v1/regions/{region}/nodes/{node_id} | Get a node in a cluster |
NodesApi | list_nodes | GET /k8s/v1/regions/{region}/clusters/{cluster_id}/nodes | List all the nodes in a cluster |
NodesApi | reboot_node | POST /k8s/v1/regions/{region}/nodes/{node_id}/reboot | Reboot a node in a cluster |
NodesApi | replace_node | POST /k8s/v1/regions/{region}/nodes/{node_id}/replace | Replace a node in a cluster |
OSApi | get_os | GET /baremetal/v1/zones/{zone}/os/{os_id} | Get an OS with a given ID |
OSApi | list_os | GET /baremetal/v1/zones/{zone}/os | List all available OS that can be install on an elastic metal server |
OffersApi | get_offer | GET /baremetal/v1/zones/{zone}/offers/{offer_id} | Get offer |
OffersApi | list_offers | GET /baremetal/v1/zones/{zone}/offers | List offers |
OptionsApi | get_option | GET /baremetal/v1/zones/{zone}/options/{option_id} | Get option |
OptionsApi | list_options | GET /baremetal/v1/zones/{zone}/options | List options |
OptionsApi | list_settings | GET /baremetal/v1/zones/{zone}/settings | List all settings |
OptionsApi | update_setting | PATCH /baremetal/v1/zones/{zone}/settings/{setting_id} | Update setting |
PoolsApi | create_pool | POST /k8s/v1/regions/{region}/clusters/{cluster_id}/pools | Create a new pool in a cluster |
PoolsApi | delete_pool | DELETE /k8s/v1/regions/{region}/pools/{pool_id} | Delete a pool in a cluster |
PoolsApi | get_pool | GET /k8s/v1/regions/{region}/pools/{pool_id} | Get a pool in a cluster |
PoolsApi | list_pools | GET /k8s/v1/regions/{region}/clusters/{cluster_id}/pools | List all the pools in a cluster |
PoolsApi | update_pool | PATCH /k8s/v1/regions/{region}/pools/{pool_id} | Update a pool in a cluster |
PoolsApi | upgrade_pool | POST /k8s/v1/regions/{region}/pools/{pool_id}/upgrade | Upgrade a pool in a cluster |
PrivateNetworksApi | create_private_network | POST /vpc/v1/zones/{zone}/private-networks | Create a private network |
PrivateNetworksApi | delete_private_network | DELETE /vpc/v1/zones/{zone}/private-networks/{private_network_id} | Delete a private network |
PrivateNetworksApi | get_private_network | GET /vpc/v1/zones/{zone}/private-networks/{private_network_id} | Get a private network |
PrivateNetworksApi | list_private_networks | GET /vpc/v1/zones/{zone}/private-networks | List private networks |
PrivateNetworksApi | update_private_network | PATCH /vpc/v1/zones/{zone}/private-networks/{private_network_id} | Update private network |
PrivilegesApi | list_privileges | GET /rdb/v1/regions/{region}/instances/{instance_id}/privileges | List privileges of a given user for a given database on a given instance |
PrivilegesApi | set_privilege | PUT /rdb/v1/regions/{region}/instances/{instance_id}/privileges | Set privileges of a given user for a given database on a given instance |
RecordsApi | clear_dns_zone_records | DELETE /domain/v2beta1/dns-zones/{dns_zone}/records | Clear DNS zone records |
RecordsApi | list_dns_zone_nameservers | GET /domain/v2beta1/dns-zones/{dns_zone}/nameservers | List DNS zone nameservers |
RecordsApi | list_dns_zone_records | GET /domain/v2beta1/dns-zones/{dns_zone}/records | List DNS zone records |
RecordsApi | update_dns_zone_nameservers | PUT /domain/v2beta1/dns-zones/{dns_zone}/nameservers | Update DNS zone nameservers |
RecordsApi | update_dns_zone_records | PATCH /domain/v2beta1/dns-zones/{dns_zone}/records | Update DNS zone records |
ServerActionsApi | reboot_server | POST /baremetal/v1/zones/{zone}/servers/{server_id}/reboot | Reboot an elastic metal server |
ServerActionsApi | start_server | POST /baremetal/v1/zones/{zone}/servers/{server_id}/start | Start an elastic metal server |
ServerActionsApi | stop_server | POST /baremetal/v1/zones/{zone}/servers/{server_id}/stop | Stop an elastic metal server |
ServersApi | add_option_server | POST /baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id} | Add server option |
ServersApi | create_server | POST /baremetal/v1/zones/{zone}/servers | Create an elastic metal server |
ServersApi | delete_option_server | DELETE /baremetal/v1/zones/{zone}/servers/{server_id}/options/{option_id} | Delete server option |
ServersApi | delete_server | DELETE /baremetal/v1/zones/{zone}/servers/{server_id} | Delete an elastic metal server |
ServersApi | get_server | GET /baremetal/v1/zones/{zone}/servers/{server_id} | Get a specific elastic metal server |
ServersApi | get_server_metrics | GET /baremetal/v1/zones/{zone}/servers/{server_id}/metrics | Return server metrics |
ServersApi | install_server | POST /baremetal/v1/zones/{zone}/servers/{server_id}/install | Install an elastic metal server |
ServersApi | list_server_events | GET /baremetal/v1/zones/{zone}/servers/{server_id}/events | List server events |
ServersApi | list_servers | GET /baremetal/v1/zones/{zone}/servers | List elastic metal servers for organization |
ServersApi | update_ip | PATCH /baremetal/v1/zones/{zone}/servers/{server_id}/ips/{ip_id} | Update IP |
ServersApi | update_server | PATCH /baremetal/v1/zones/{zone}/servers/{server_id} | Update an elastic metal server |
SnapshotsApi | create_instance_from_snapshot | POST /rdb/v1/regions/{region}/snapshots/{snapshot_id}/create-instance | Create a new instance from a given snapshot |
SnapshotsApi | create_snapshot | POST /rdb/v1/regions/{region}/instances/{instance_id}/snapshots | Create an instance snapshot |
SnapshotsApi | delete_snapshot | DELETE /rdb/v1/regions/{region}/snapshots/{snapshot_id} | Delete an instance snapshot |
SnapshotsApi | get_snapshot | GET /rdb/v1/regions/{region}/snapshots/{snapshot_id} | Get an instance snapshot |
SnapshotsApi | list_snapshots | GET /rdb/v1/regions/{region}/snapshots | List instance snapshots |
SnapshotsApi | update_snapshot | PATCH /rdb/v1/regions/{region}/snapshots/{snapshot_id} | Update an instance snapshot |
TagsApi | delete_tag | DELETE /registry/v1/regions/{region}/tags/{tag_id} | Delete a tag |
TagsApi | get_tag | GET /registry/v1/regions/{region}/tags/{tag_id} | Get a tag |
TagsApi | list_tags | GET /registry/v1/regions/{region}/images/{image_id}/tags | List all your tags |
UsersApi | create_user | POST /rdb/v1/regions/{region}/instances/{instance_id}/users | Create a user on a given instance |
UsersApi | delete_user | DELETE /rdb/v1/regions/{region}/instances/{instance_id}/users/{name} | Delete a user on a given instance |
UsersApi | list_users | GET /rdb/v1/regions/{region}/instances/{instance_id}/users | List users of a given instance |
UsersApi | update_user | PATCH /rdb/v1/regions/{region}/instances/{instance_id}/users/{name} | Update a user on a given instance |
VersionsApi | get_dns_zone_version_diff | GET /domain/v2beta1/dns-zones/version/{dns_zone_version_id}/diff | Get DNS zone version diff |
VersionsApi | get_version | GET /k8s/v1/regions/{region}/versions/{version_name} | Get details about a specific version |
VersionsApi | list_dns_zone_version_records | GET /domain/v2beta1/dns-zones/version/{dns_zone_version_id} | List DNS zone version records |
VersionsApi | list_dns_zone_versions | GET /domain/v2beta1/dns-zones/{dns_zone}/versions | List DNS zone versions |
VersionsApi | list_versions | GET /k8s/v1/regions/{region}/versions | List all available versions |
VersionsApi | restore_dns_zone_version | POST /domain/v2beta1/dns-zones/version/{dns_zone_version_id}/restore | Restore DNS zone version |
Documentation For Models
- AddInstanceAclRulesRequest
- AddInstanceSettingsRequest
- AddOptionServerRequest
- AttachFlexibleIpRequest
- CloneDnsZoneRequest
- CloneInstanceRequest
- CreateClusterRequest
- CreateClusterRequestAutoUpgrade
- CreateClusterRequestAutoUpgradeMaintenanceWindow
- CreateClusterRequestAutoscalerConfig
- CreateClusterRequestAutoscalerConfigScaleDownUtilizationThreshold
- CreateClusterRequestOpenIdConnectConfig
- CreateDatabaseBackupRequest
- CreateDatabaseRequest
- CreateDeviceRequest
- CreateDeviceRequestMessageFilters
- CreateDeviceRequestMessageFiltersPublish
- CreateDeviceRequestMessageFiltersSubscribe
- CreateDnsZoneRequest
- CreateEndpointRequest
- CreateEndpointRequestEndpointSpec
- CreateEndpointRequestEndpointSpecPrivateNetwork
- CreateFlexibleIpRequest
- CreateHubRequest
- CreateHubRequestTwinsGraphiteConfig
- CreateInstanceFromSnapshotRequest
- CreateInstanceRequest
- CreateNamespaceRequest
- CreateNetworkRequest
- CreatePoolRequest
- CreatePoolRequestKubeletArgs
- CreatePoolRequestUpgradePolicy
- CreatePrivateNetworkRequest
- CreateRouteRequest
- CreateRouteRequestDbConfig
- CreateRouteRequestRestConfig
- CreateRouteRequestRestConfigHeaders
- CreateRouteRequestS3Config
- CreateServerRequest
- CreateServerRequestInstall
- CreateSnapshotRequest
- CreateSslCertificateRequest
- CreateUserRequest
- DeleteInstanceAclRulesRequest
- DeleteInstanceSettingsRequest
- DetachFlexibleIpRequest
- DuplicateMacAddrRequest
- GenerateMacAddrRequest
- GoogleProtobufValue
- GoogleProtobufValueListValue
- GoogleProtobufValueStructValue
- ImportProviderDnsZoneRequest
- ImportProviderDnsZoneRequestOnlineV1
- ImportRawDnsZoneRequest
- ImportRawDnsZoneRequestAxfrSource
- ImportRawDnsZoneRequestBindSource
- InstallServerRequest
- MoveMacAddrRequest
- PatchTwinDocumentRequest
- PatchTwinDocumentRequestData
- PrepareInstanceLogsRequest
- PurgeInstanceLogsRequest
- PutTwinDocumentRequest
- PutTwinDocumentRequestData
- PutTwinDocumentRequestDataFields
- RebootServerRequest
- RefreshDnsZoneRequest
- RestoreDatabaseBackupRequest
- ScalewayBaremetalV1BmcAccess
- ScalewayBaremetalV1Cpu
- ScalewayBaremetalV1Disk
- ScalewayBaremetalV1GetServerMetricsResponse
- ScalewayBaremetalV1GetServerMetricsResponsePings
- ScalewayBaremetalV1GetServerMetricsResponsePingsMetadata
- ScalewayBaremetalV1Ip
- ScalewayBaremetalV1ListOffersResponse
- ScalewayBaremetalV1ListOptionsResponse
- ScalewayBaremetalV1ListOsResponse
- ScalewayBaremetalV1ListServerEventsResponse
- ScalewayBaremetalV1ListServersResponse
- ScalewayBaremetalV1ListSettingsResponse
- ScalewayBaremetalV1Memory
- ScalewayBaremetalV1Offer
- ScalewayBaremetalV1OfferFee
- ScalewayBaremetalV1OfferOptionOffer
- ScalewayBaremetalV1OfferOptionOfferPrice
- ScalewayBaremetalV1OfferPricePerHour
- ScalewayBaremetalV1OfferPricePerMonth
- ScalewayBaremetalV1Option
- ScalewayBaremetalV1Os
- ScalewayBaremetalV1OsPassword
- ScalewayBaremetalV1OsServicePassword
- ScalewayBaremetalV1OsServiceUser
- ScalewayBaremetalV1OsSsh
- ScalewayBaremetalV1OsUser
- ScalewayBaremetalV1PersistentMemory
- ScalewayBaremetalV1RaidController
- ScalewayBaremetalV1Server
- ScalewayBaremetalV1ServerEvent
- ScalewayBaremetalV1ServerInstall
- ScalewayBaremetalV1ServerOption
- ScalewayBaremetalV1ServerRescueServer
- ScalewayBaremetalV1Setting
- ScalewayDomainV2beta1DnsZone
- ScalewayDomainV2beta1DnsZoneStatus
- ScalewayDomainV2beta1DnsZoneVersion
- ScalewayDomainV2beta1GetDnsZoneTsigKeyResponse
- ScalewayDomainV2beta1GetDnsZoneVersionDiffResponse
- ScalewayDomainV2beta1ImportProviderDnsZoneResponse
- ScalewayDomainV2beta1ImportRawDnsZoneRequestTsigKey
- ScalewayDomainV2beta1ImportRawDnsZoneResponse
- ScalewayDomainV2beta1ListDnsZoneNameserversResponse
- ScalewayDomainV2beta1ListDnsZoneRecordsResponse
- ScalewayDomainV2beta1ListDnsZoneVersionRecordsResponse
- ScalewayDomainV2beta1ListDnsZoneVersionsResponse
- ScalewayDomainV2beta1ListDnsZonesResponse
- ScalewayDomainV2beta1ListSslCertificatesResponse
- ScalewayDomainV2beta1Nameserver
- ScalewayDomainV2beta1RawFormat
- ScalewayDomainV2beta1Record
- ScalewayDomainV2beta1RecordChange
- ScalewayDomainV2beta1RecordChangeAdd
- ScalewayDomainV2beta1RecordChangeDelete
- ScalewayDomainV2beta1RecordChangeSet
- ScalewayDomainV2beta1RecordChangeSetIdFields
- ScalewayDomainV2beta1RecordGeoIpConfig
- ScalewayDomainV2beta1RecordGeoIpConfigMatch
- ScalewayDomainV2beta1RecordHttpServiceConfig
- ScalewayDomainV2beta1RecordHttpServiceConfigStrategy
- ScalewayDomainV2beta1RecordType
- ScalewayDomainV2beta1RecordViewConfig
- ScalewayDomainV2beta1RecordViewConfigView
- ScalewayDomainV2beta1RecordWeightedConfig
- ScalewayDomainV2beta1RecordWeightedConfigWeightedIp
- ScalewayDomainV2beta1RefreshDnsZoneResponse
- ScalewayDomainV2beta1SslCertificate
- ScalewayDomainV2beta1SslCertificateStatus
- ScalewayDomainV2beta1UpdateDnsZoneNameserversResponse
- ScalewayDomainV2beta1UpdateDnsZoneRecordsResponse
- ScalewayFlexibleIpV1alpha1AttachFlexibleIpsResponse
- ScalewayFlexibleIpV1alpha1DetachFlexibleIpsResponse
- ScalewayFlexibleIpV1alpha1FlexibleIp
- ScalewayFlexibleIpV1alpha1FlexibleIpMacAddress
- ScalewayFlexibleIpV1alpha1FlexibleIpStatus
- ScalewayFlexibleIpV1alpha1ListFlexibleIpsResponse
- ScalewayIotV1CreateDeviceResponse
- ScalewayIotV1CreateDeviceResponseCertificate
- ScalewayIotV1CreateDeviceResponseDevice
- ScalewayIotV1CreateNetworkResponse
- ScalewayIotV1CreateNetworkResponseNetwork
- ScalewayIotV1Device
- ScalewayIotV1DeviceMessageFiltersRulePolicy
- ScalewayIotV1GetDeviceCertificateResponse
- ScalewayIotV1GetDeviceMetricsResponse
- ScalewayIotV1GetHubCaResponse
- ScalewayIotV1GetHubMetricsResponse
- ScalewayIotV1Hub
- ScalewayIotV1ListDevicesResponse
- ScalewayIotV1ListHubsResponse
- ScalewayIotV1ListNetworksResponse
- ScalewayIotV1ListRoutesResponse
- ScalewayIotV1ListTwinDocumentsResponse
- ScalewayIotV1ListTwinDocumentsResponseDocumentSummary
- ScalewayIotV1Network
- ScalewayIotV1RenewDeviceCertificateResponse
- ScalewayIotV1Route
- ScalewayIotV1RouteDatabaseConfigEngine
- ScalewayIotV1RouteDbConfig
- ScalewayIotV1RouteRestConfig
- ScalewayIotV1RouteRestConfigHeaders
- ScalewayIotV1RouteRestConfigHttpVerb
- ScalewayIotV1RouteS3Config
- ScalewayIotV1RouteS3ConfigS3Strategy
- ScalewayIotV1RouteSummary
- ScalewayIotV1SetDeviceCertificateResponse
- ScalewayIotV1TwinDocument
- ScalewayIotV1TwinDocumentData
- ScalewayK8sV1Cluster
- ScalewayK8sV1ClusterAutoUpgrade
- ScalewayK8sV1ClusterAutoscalerConfig
- ScalewayK8sV1ClusterOpenIdConnectConfig
- ScalewayK8sV1Cni
- ScalewayK8sV1CreateClusterRequestPoolConfig
- ScalewayK8sV1CreateClusterRequestPoolConfigUpgradePolicy
- ScalewayK8sV1Ingress
- ScalewayK8sV1ListClusterAvailableVersionsResponse
- ScalewayK8sV1ListClustersResponse
- ScalewayK8sV1ListNodesResponse
- ScalewayK8sV1ListPoolsResponse
- ScalewayK8sV1ListVersionsResponse
- ScalewayK8sV1Node
- ScalewayK8sV1NodeConditions
- ScalewayK8sV1Pool
- ScalewayK8sV1PoolUpgradePolicy
- ScalewayK8sV1Runtime
- ScalewayK8sV1Version
- ScalewayK8sV1VersionAvailableKubeletArgs
- ScalewayRdbV1AclRule
- ScalewayRdbV1AclRuleAction
- ScalewayRdbV1AclRuleDirection
- ScalewayRdbV1AclRuleProtocol
- ScalewayRdbV1AclRuleRequest
- ScalewayRdbV1AddInstanceAclRulesResponse
- ScalewayRdbV1AddInstanceSettingsResponse
- ScalewayRdbV1Database
- ScalewayRdbV1DatabaseBackup
- ScalewayRdbV1DatabaseEngine
- ScalewayRdbV1DeleteInstanceAclRulesResponse
- ScalewayRdbV1DeleteInstanceSettingsResponse
- ScalewayRdbV1Endpoint
- ScalewayRdbV1EndpointPrivateNetwork
- ScalewayRdbV1EndpointSpec
- ScalewayRdbV1EngineSetting
- ScalewayRdbV1EngineSettingFloatMax
- ScalewayRdbV1EngineSettingFloatMin
- ScalewayRdbV1EngineVersion
- ScalewayRdbV1Instance
- ScalewayRdbV1InstanceBackupSchedule
- ScalewayRdbV1InstanceEndpoint
- ScalewayRdbV1InstanceLog
- ScalewayRdbV1InstanceMetrics
- ScalewayRdbV1InstanceSetting
- ScalewayRdbV1InstanceVolume
- ScalewayRdbV1ListDatabaseBackupsResponse
- ScalewayRdbV1ListDatabaseEnginesResponse
- ScalewayRdbV1ListDatabasesResponse
- ScalewayRdbV1ListInstanceAclRulesResponse
- ScalewayRdbV1ListInstanceLogsDetailsResponse
- ScalewayRdbV1ListInstanceLogsDetailsResponseInstanceLogDetail
- ScalewayRdbV1ListInstanceLogsResponse
- ScalewayRdbV1ListInstancesResponse
- ScalewayRdbV1ListNodeTypesResponse
- ScalewayRdbV1ListPrivilegesResponse
- ScalewayRdbV1ListSnapshotsResponse
- ScalewayRdbV1ListUsersResponse
- ScalewayRdbV1Maintenance
- ScalewayRdbV1NodeType
- ScalewayRdbV1NodeTypeVolumeConstraint
- ScalewayRdbV1NodeTypeVolumeType
- ScalewayRdbV1PrepareInstanceLogsResponse
- ScalewayRdbV1Privilege
- ScalewayRdbV1SetInstanceAclRulesResponse
- ScalewayRdbV1SetInstanceSettingsResponse
- ScalewayRdbV1Snapshot
- ScalewayRdbV1User
- ScalewayRdbV1VolumeType
- ScalewayRegistryV1Image
- ScalewayRegistryV1ListImagesResponse
- ScalewayRegistryV1ListNamespacesResponse
- ScalewayRegistryV1ListTagsResponse
- ScalewayRegistryV1Namespace
- ScalewayRegistryV1Tag
- ScalewayStdFile
- ScalewayStdMapStringStringValue
- ScalewayStdStringsValue
- ScalewayStdTimeSeries
- ScalewayStdTimeSeriesPoint
- ScalewayStdTimeSeriesPointInner
- ScalewayVpcV1ListPrivateNetworksResponse
- ScalewayVpcV1PrivateNetwork
- SetDeviceCertificateRequest
- SetHubCaRequest
- SetInstanceAclRulesRequest
- SetInstanceSettingsRequest
- SetPrivilegeRequest
- StartBmcAccessRequest
- UpdateClusterRequest
- UpdateClusterRequestAutoUpgrade
- UpdateClusterRequestAutoscalerConfig
- UpdateClusterRequestOpenIdConnectConfig
- UpdateDatabaseBackupRequest
- UpdateDeviceRequest
- UpdateDeviceRequestMessageFilters
- UpdateDnsZoneNameserversRequest
- UpdateDnsZoneRecordsRequest
- UpdateDnsZoneRequest
- UpdateFlexibleIpRequest
- UpdateHubRequest
- UpdateImageRequest
- UpdateInstanceRequest
- UpdateInstanceRequestLogsPolicy
- UpdateIpRequest
- UpdateNamespaceRequest
- UpdatePoolRequest
- UpdatePoolRequestKubeletArgs
- UpdatePrivateNetworkRequest
- UpdateRouteRequest
- UpdateRouteRequestDbConfig
- UpdateRouteRequestRestConfig
- UpdateRouteRequestS3Config
- UpdateServerRequest
- UpdateSettingRequest
- UpdateSnapshotRequest
- UpdateUserRequest
- UpgradeClusterRequest
- UpgradeInstanceRequest
- UpgradePoolRequest
To get access to the crate's generated documentation, use:
cargo doc --open