Skip to content

Qovery/scaleway-api-rs

BranchesTags

Repository files navigation

build / test / fmt crate publish publish Crates.io

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

Scaleway Elastic Metal servers are dedicated physical servers that you can order on-demand, like Instances. You can install an OS or other images on your Elastic Metal server and connect to it via SSH to use it as you require. You can power off the server when you are not using or delete it from your account once you have finished using it. Elastic Metal servers are ideal for large workloads, big data, and applications that require increased security and dedicated resources.

(switchcolumn) <Message type="tip"> Check out our dedicated APIs to manage Private Networks and Flexible IPs for Elastic Metal servers. (switchcolumn)

Concepts

Refer to our dedicated concepts page to find definitions of the different terms referring to Elastic Metal servers.

Quickstart

(switchcolumn) (switchcolumn)

  1. Configure your environment variables.

    export PROJECT_ID=\"<project-id>\"
export ACCESS_KEY=\"<access-key>\"
export SECRET_KEY=\"<secret-key>\"
export ZONE=\"<availability-zone>\"

    <Message type="note"> This is an optional step that seeks to simplify your usage of the Bare Metal API.

  2. Edit the POST request payload that we will use in the next step to create an Elastic Metal server. Modify the values in the example according to your needs, using the information in the table to help.

    {
\"offer_id\": \"string\",
\"project_id\": \"string\",
\"name\": \"string\",
\"description\": \"string\",
\"tags\": [
    \"tag1\", \"tag2\"
],
\"install\": {
    \"os_id\": \"string\",
    \"hostname\": \"string\",
    \"ssh_key_ids\": [
    \"string\"
    ],
    \"user\": \"string\",
    \"password\": \"string\",
    \"service_user\": \"string\",
    \"service_password\": \"string\"
},
\"option_ids\": [
    \"string\"
]
}
    Parameter Description
    offer_id REQUIRED UUID of the Elastic Metal offer
    project_id REQUIRED UUID of the project you want to create your Elastic Metal in.
    name REQUIRED Name of the Elastic Metal server (≠hostname)
    description REQUIRED A description of your server (max 255 characters)
    tags OPTIONAL An array of tags associated with your server
    os_id The ID of the operating system image to install on the server
    hostname Hostname of the server
    ssh_key_ids SSH key IDs authorized on the server
    user NULLABLE A regular user to be configured on the server
    password NULLABLE The password for the user account
    service_user NULLABLE A service user for third party services (user to login in services such as BigBlueButton)
    service password NULLABLE Password for the service user
    option_ids IDs of options to enable on server

    <Message type="tip"> To find your Project ID you can either use the IAM API or the Scaleway console:

  3. Run the following command to create an Elastic Metal server. Make sure you include the payload you edited in the previous step.

    curl -X POST \\
  -H \"Content-Type: application/json\" \\
  -H \"X-Auth-Token: $SECRET_KEY\" https://api.scaleway.com//baremetal/v1/zones/$ZONE/servers \\
  -d '{
    \"offer_id\": \"bd757ca3-a71b-4158-9ef5-39436b6db2a4\",
    \"project_id\": \"cc6d123a-bc09-4e24-b5d9-3310f2104e13\",
    \"name\": \"MyElasticMetal\",
    \"description\": \"My_Elastic_Metal_Server\",
    \"tags\": [
        \"Ubuntu22\", \"Dedicated\"
    ],
    \"install\": {
        \"os_id\": \"96e5f0f2-d216-4de2-8a15-68730d877885\",
        \"hostname\": \"elasticmetal.example.com\",
        \"ssh_key_ids\": [
        \"fa05e77f-66b7-43b9-bc21-4dfe3c5bb624\"
        ],
        \"user\": \"ubuntu\",
        \"password\": \"mySecretPa$$word\"
    \"option_ids\": [
        \"string\"
    ]
  }\"

  4. List your Elastic Metal servers.

    curl -X GET \\
  -H \"Content-Type: application/json\" \\
  -H \"X-Auth-Token: $SECRET_KEY\" https://api.scaleway.com/baremetal/v1/zones/$ZONE/servers

  5. Retrieve your Elastic Metal server IP from the response.

  6. Connect to your Elastic Metal server using SSH

    ssh root@my-elastic-metal-server-ip

(switchcolumn) <Message type="requirement"> To perform the following steps, you must first ensure that:

(switchcolumn)

Technical information

Features

  • Installation (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 OS experiencing failures. When your server boot on rescue, you can mount your disks and start diagnosing/fixing your image.
  • Billed by the minute (billing starts when the server is delivered and stops when the server is deleted)
  • IPv6, all servers are available with a /128 IPv6 subnet
  • 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)

Availability Zones

Scaleway's infrastructure is spread across different regions and Availability Zones.

Elastic Metal servers are available in Paris, Amsterdam, and Warsaw regions, with product availability in the following AZs:

Name API ID
Paris fr-par-1 fr-par-2
Amsterdam nl-ams-1 nl-ams-2
Warsaw pl-waw-2 pl-waw-3

Technical limitations

  • Failover IPs are not available in API v1, use the API v1alpha1

Going further

For more help using Scaleway Elastic Metal servers, check out the following resources:

Troubleshooting

How is the installation of Elastic Metal servers done?

  • The installation of Elastic Metal servers is done by preseed (± 10min) (preseed: complete install from a virtual media)

How can I retrieve my secret key and Project ID?

You can find your secret key and your Project ID in the Scaleway console.

How can I add my server to a Private Network?

See our dedicated documentation.

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.1.0
  • Generator version: 7.13.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
AclsApi add_instance_acl_rules POST /rdb/v1/regions/{region}/instances/{instance_id}/acls Add an ACL rule to a Database Instance
AclsApi delete_instance_acl_rules DELETE /rdb/v1/regions/{region}/instances/{instance_id}/acls Delete ACL rules of a Database Instance
AclsApi list_instance_acl_rules GET /rdb/v1/regions/{region}/instances/{instance_id}/acls List ACL rules of a Database Instance
AclsApi set_instance_acl_rules PUT /rdb/v1/regions/{region}/instances/{instance_id}/acls Set ACL rules for a Database Instance
AccessControlListApi add_cluster_acl_rules POST /k8s/v1/regions/{region}/clusters/{cluster_id}/acls Add new ACLs
AccessControlListApi delete_acl_rule DELETE /k8s/v1/regions/{region}/acls/{acl_id} Delete an existing ACL
AccessControlListApi list_cluster_acl_rules GET /k8s/v1/regions/{region}/clusters/{cluster_id}/acls List ACLs
AccessControlListApi set_cluster_acl_rules PUT /k8s/v1/regions/{region}/clusters/{cluster_id}/acls Set new ACLs
BmcAccessApi get_bmc_access GET /baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access Get BMC access
BmcAccessApi start_bmc_access POST /baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access Start BMC access
BmcAccessApi stop_bmc_access DELETE /baremetal/v1/zones/{zone}/servers/{server_id}/bmc-access Stop BMC access
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
ClusterTypesApi list_cluster_types GET /k8s/v1/regions/{region}/cluster-types List cluster types
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_types GET /k8s/v1/regions/{region}/clusters/{cluster_id}/available-types List available cluster types 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 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 set_cluster_type POST /k8s/v1/regions/{region}/clusters/{cluster_id}/set-type Change the Cluster type
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 get the DNS zone's TLS certificate
DnsZonesApi delete_dns_zone DELETE /domain/v2beta1/dns-zones/{dns_zone} Delete a DNS zone
DnsZonesApi delete_dns_zone_tsig_key DELETE /domain/v2beta1/dns-zones/{dns_zone}/tsig-key Delete the DNS zone's TSIG key
DnsZonesApi delete_ssl_certificate DELETE /domain/v2beta1/ssl-certificates/{dns_zone} Delete a TLS certificate
DnsZonesApi get_dns_zone_tsig_key GET /domain/v2beta1/dns-zones/{dns_zone}/tsig-key Get the DNS zone's TSIG key
DnsZonesApi get_ssl_certificate GET /domain/v2beta1/ssl-certificates/{dns_zone} Get a DNS zone's TLS certificate
DnsZonesApi list_dns_zones GET /domain/v2beta1/dns-zones List DNS zones
DnsZonesApi list_ssl_certificates GET /domain/v2beta1/ssl-certificates List a user's TLS certificates
DnsZonesApi refresh_dns_zone POST /domain/v2beta1/dns-zones/{dns_zone}/refresh Refresh a DNS zone
DnsZonesApi update_dns_zone PATCH /domain/v2beta1/dns-zones/{dns_zone} Update a DNS zone
DatabaseInstancesApi apply_instance_maintenance POST /rdb/v1/regions/{region}/instances/{instance_id}/apply-maintenance Apply Database Instance maintenance
DatabaseInstancesApi clone_instance POST /rdb/v1/regions/{region}/instances/{instance_id}/clone Clone a Database Instance
DatabaseInstancesApi create_instance POST /rdb/v1/regions/{region}/instances Create a Database Instance
DatabaseInstancesApi delete_instance DELETE /rdb/v1/regions/{region}/instances/{instance_id} Delete a Database Instance
DatabaseInstancesApi get_instance GET /rdb/v1/regions/{region}/instances/{instance_id} Get a Database Instance
DatabaseInstancesApi get_instance_certificate GET /rdb/v1/regions/{region}/instances/{instance_id}/certificate Get the TLS certificate of a Database Instance
DatabaseInstancesApi get_instance_log GET /rdb/v1/regions/{region}/logs/{instance_log_id} Get given logs of a Database Instance
DatabaseInstancesApi get_instance_metrics GET /rdb/v1/regions/{region}/instances/{instance_id}/metrics Get Database Instance metrics
DatabaseInstancesApi list_instance_logs GET /rdb/v1/regions/{region}/instances/{instance_id}/logs List available logs of a Database Instance
DatabaseInstancesApi list_instance_logs_details GET /rdb/v1/regions/{region}/instances/{instance_id}/logs-details List remote Database Instance logs details
DatabaseInstancesApi list_instances GET /rdb/v1/regions/{region}/instances List Database Instances
DatabaseInstancesApi prepare_instance_logs POST /rdb/v1/regions/{region}/instances/{instance_id}/prepare-logs Prepare logs of a Database Instance
DatabaseInstancesApi purge_instance_logs POST /rdb/v1/regions/{region}/instances/{instance_id}/purge-logs Purge remote Database Instance logs
DatabaseInstancesApi renew_instance_certificate POST /rdb/v1/regions/{region}/instances/{instance_id}/renew-certificate Renew the TLS certificate of a Database Instance
DatabaseInstancesApi restart_instance POST /rdb/v1/regions/{region}/instances/{instance_id}/restart Restart Database Instance
DatabaseInstancesApi update_instance PATCH /rdb/v1/regions/{region}/instances/{instance_id} Update a Database Instance
DatabaseInstancesApi upgrade_instance POST /rdb/v1/regions/{region}/instances/{instance_id}/upgrade Upgrade a Database Instance
DatabasesApi create_database POST /rdb/v1/regions/{region}/instances/{instance_id}/databases Create a database in a Database Instance
DatabasesApi delete_database DELETE /rdb/v1/regions/{region}/instances/{instance_id}/databases/{name} Delete a database in a Database Instance
DatabasesApi list_databases GET /rdb/v1/regions/{region}/instances/{instance_id}/databases List databases in a Database Instance
EndpointsApi create_endpoint POST /rdb/v1/regions/{region}/instances/{instance_id}/endpoints Create a new Database Instance endpoint
EndpointsApi delete_endpoint DELETE /rdb/v1/regions/{region}/endpoints/{endpoint_id} Delete a Database Instance endpoint
EndpointsApi get_endpoint GET /rdb/v1/regions/{region}/endpoints/{endpoint_id} Get a Database Instance endpoint
EndpointsApi migrate_endpoint POST /rdb/v1/regions/{region}/endpoints/{endpoint_id}/migrate Migrate an existing instance endpoint to another instance
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 an existing flexible IP to a server
FlexibleIpApi create_flexible_ip POST /flexible-ip/v1alpha1/zones/{zone}/fips Create a new flexible IP
FlexibleIpApi delete_flexible_ip DELETE /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id} Delete an existing flexible IP
FlexibleIpApi delete_mac_addr DELETE /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac Detach a given virtual MAC address from an existing flexible IP
FlexibleIpApi detach_flexible_ip POST /flexible-ip/v1alpha1/zones/{zone}/fips/detach Detach an existing flexible IP from a server
FlexibleIpApi duplicate_mac_addr POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/duplicate Duplicate a virtual MAC address to another flexible IP
FlexibleIpApi generate_mac_addr POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac Generate a virtual MAC address on an existing flexible IP
FlexibleIpApi get_flexible_ip GET /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id} Get an existing flexible IP
FlexibleIpApi list_flexible_ips GET /flexible-ip/v1alpha1/zones/{zone}/fips List flexible IPs
FlexibleIpApi move_mac_addr POST /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id}/mac/move Relocate an existing virtual MAC address to a different flexible IP
FlexibleIpApi update_flexible_ip PATCH /flexible-ip/v1alpha1/zones/{zone}/fips/{fip_id} Update an existing 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 an image
ImagesApi list_images GET /registry/v1/regions/{region}/images List images
ImagesApi update_image PATCH /registry/v1/regions/{region}/images/{image_id} Update an image
ImportsExportsApi export_raw_dns_zone GET /domain/v2beta1/dns-zones/{dns_zone}/raw Export a raw DNS zone
ImportsExportsApi import_provider_dns_zone POST /domain/v2beta1/dns-zones/{dns_zone}/import-provider Import a DNS zone from another provider
ImportsExportsApi import_raw_dns_zone POST /domain/v2beta1/dns-zones/{dns_zone}/raw Import a raw DNS zone
InstanceSettingsApi add_instance_settings POST /rdb/v1/regions/{region}/instances/{instance_id}/settings Add Database Instance advanced settings
InstanceSettingsApi delete_instance_settings DELETE /rdb/v1/regions/{region}/instances/{instance_id}/settings Delete Database Instance advanced settings
InstanceSettingsApi set_instance_settings PUT /rdb/v1/regions/{region}/instances/{instance_id}/settings Set Database Instance advanced settings
NamespacesApi create_namespace POST /registry/v1/regions/{region}/namespaces Create a namespace
NamespacesApi delete_namespace DELETE /registry/v1/regions/{region}/namespaces/{namespace_id} Delete a 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 namespaces
NamespacesApi update_namespace PATCH /registry/v1/regions/{region}/namespaces/{namespace_id} Update a namespace
NodeTypesApi list_node_types GET /rdb/v1/regions/{region}/node-types List available node types
NodesApi create_external_node POST /k8s/v1/regions/{region}/pools/{pool_id}/external-nodes Create a Kosmos node
NodesApi delete_node DELETE /k8s/v1/regions/{region}/nodes/{node_id} Delete a Node in a Cluster
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 Nodes in a Cluster
NodesApi reboot_node POST /k8s/v1/regions/{region}/nodes/{node_id}/reboot Reboot a Node in a Cluster
OsApi get_os GET /baremetal/v1/zones/{zone}/os/{os_id} Get OS with an ID
OsApi list_os GET /baremetal/v1/zones/{zone}/os List available OSes
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
PartitioningSchemasApi get_default_partitioning_schema GET /baremetal/v1/zones/{zone}/partitioning-schemas/default Get default partitioning schema
PartitioningSchemasApi validate_partitioning_schema POST /baremetal/v1/zones/{zone}/partitioning-schemas/validate Validate client partitioning schema
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 Pools in a Cluster
PoolsApi migrate_pools_to_new_images POST /k8s/v1/regions/{region}/clusters/{cluster_id}/migrate-pools-to-new-images Migrate specific pools or all pools of a cluster to new images.
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 user privileges for a database
PrivilegesApi set_privilege PUT /rdb/v1/regions/{region}/instances/{instance_id}/privileges Set user privileges for a database
ReadReplicasApi create_read_replica POST /rdb/v1/regions/{region}/read-replicas Create a Read Replica
ReadReplicasApi create_read_replica_endpoint POST /rdb/v1/regions/{region}/read-replicas/{read_replica_id}/endpoints Create an endpoint for a Read Replica
ReadReplicasApi delete_read_replica DELETE /rdb/v1/regions/{region}/read-replicas/{read_replica_id} Delete a Read Replica
ReadReplicasApi get_read_replica GET /rdb/v1/regions/{region}/read-replicas/{read_replica_id} Get a Read Replica
ReadReplicasApi promote_read_replica POST /rdb/v1/regions/{region}/read-replicas/{read_replica_id}/promote Promote a Read Replica
ReadReplicasApi reset_read_replica POST /rdb/v1/regions/{region}/read-replicas/{read_replica_id}/reset Resync a Read Replica
RecordsApi clear_dns_zone_records DELETE /domain/v2beta1/dns-zones/{dns_zone}/records Clear records within a DNS zone
RecordsApi list_dns_zone_nameservers GET /domain/v2beta1/dns-zones/{dns_zone}/nameservers List name servers within a DNS zone
RecordsApi list_dns_zone_records GET /domain/v2beta1/dns-zones/{dns_zone}/records List records within a DNS zone
RecordsApi update_dns_zone_nameservers PUT /domain/v2beta1/dns-zones/{dns_zone}/nameservers Update name servers within a DNS zone
RecordsApi update_dns_zone_records PATCH /domain/v2beta1/dns-zones/{dns_zone}/records Update records within a DNS zone
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 an Organization
ServersApi migrate_server_to_monthly_offer POST /baremetal/v1/zones/{zone}/servers/{server_id}/migrate-offer-monthly Migrate server offer
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 Database Instance from a snapshot
SnapshotsApi create_snapshot POST /rdb/v1/regions/{region}/instances/{instance_id}/snapshots Create a Database Instance snapshot
SnapshotsApi delete_snapshot DELETE /rdb/v1/regions/{region}/snapshots/{snapshot_id} Delete a Database Instance snapshot
SnapshotsApi get_snapshot GET /rdb/v1/regions/{region}/snapshots/{snapshot_id} Get a Database Instance snapshot
SnapshotsApi list_snapshots GET /rdb/v1/regions/{region}/snapshots List snapshots
SnapshotsApi update_snapshot PATCH /rdb/v1/regions/{region}/snapshots/{snapshot_id} Update a Database 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 tags
UsersApi create_user POST /rdb/v1/regions/{region}/instances/{instance_id}/users Create a user for a Database Instance
UsersApi delete_user DELETE /rdb/v1/regions/{region}/instances/{instance_id}/users/{name} Delete a user on a Database Instance
UsersApi list_users GET /rdb/v1/regions/{region}/instances/{instance_id}/users List users of a Database Instance
UsersApi update_user PATCH /rdb/v1/regions/{region}/instances/{instance_id}/users/{name} Update a user on a Database Instance
VersionsApi get_dns_zone_version_diff GET /domain/v2beta1/dns-zones/version/{dns_zone_version_id}/diff Access differences from a specific DNS zone version
VersionsApi get_version GET /k8s/v1/regions/{region}/versions/{version_name} Get a Version
VersionsApi list_dns_zone_version_records GET /domain/v2beta1/dns-zones/version/{dns_zone_version_id} List records from a given version of a specific DNS zone
VersionsApi list_dns_zone_versions GET /domain/v2beta1/dns-zones/{dns_zone}/versions List versions of a DNS zone
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 a DNS zone version

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

About

Rust lib for Scaleway API

Resources

Readme

License

GPL-3.0 license
Activity
Custom properties

Stars

9 stars

Watchers

5 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages