Client

Client

new Client(auth_token)

Source:
scaleway-api-client Client Constructor
Parameters:
Name Type Description
auth_token String Scaleway Authentication Token

Methods

AddBackendServers(region, backend_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
backend_id string Backend ID
body object Request content
Properties
Name Type Description
server_ip array Set all IPs to add on your backend
options object <nullable>
 axios http request options

AttachPrivateNetwork(region, lb_id, private_network_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
private_network_id string Set your instance private network id
body object Request content
Properties
Name Type Description
ip_address array Define two local ip address of your choice for each load balancer instance
options object <nullable>
 axios http request options

CreateAcl(region, frontend_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
frontend_id string ID of your frontend
body object Request content
Properties
Name Type Description
name string Name of your ACL ressource
action object Action to undertake when an ACL filter matches
match object The ACL match rule. You can have one of those three cases: - `ip_subnet` is defined - `http_filter` and `http_filter_value` are defined - `ip_subnet`, `http_filter` and `http_filter_value` are defined
index number Order between your Acls (ascending order, 0 is first acl executed)
options object <nullable>
 axios http request options

CreateBackend(region, lb_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
body object Request content
Properties
Name Type Description
name string Resource name
forward_protocol string Backend protocol. TCP or HTTP
forward_port number User sessions will be forwarded to this port of backend servers
forward_port_algorithm string Load balancing algorithm
sticky_sessions string Enables cookie-based session persistence
sticky_sessions_cookie_name string Cookie name for for sticky sessions
health_check object See the Healthcheck object description
server_ip array Backend server IP addresses list (IPv4 or IPv6)
send_proxy_v2 boolean Deprecated in favor of proxy_protocol field !
timeout_server number Maximum server connection inactivity time (in milliseconds)
timeout_connect number Maximum initical server connection establishment time (in milliseconds)
timeout_tunnel number Maximum tunnel inactivity time (in milliseconds)
on_marked_down_action string Modify what occurs when a backend server is marked down
proxy_protocol string The PROXY protocol informs the other end about the incoming connection, so that it can know the client's address or the public address it accessed to, whatever the upper layer protocol. `proxy_protocol_none` Disable proxy protocol. `proxy_protocol_v1` Version one (text format). `proxy_protocol_v2` Version two (binary format). `proxy_protocol_v2_ssl` Version two with SSL connection. `proxy_protocol_v2_ssl_cn` Version two with SSL connection and common name information.
options object <nullable>
 axios http request options

CreateCertificate(region, lb_id, body, optionsnullable)

Source:
Generate a new TLS certificate using Let's Encrypt or import your certificate.
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
body object Request content
Properties
Name Type Description
name string Certificate name
letsencrypt object Let's Encrypt type
custom_certificate object Custom import certificate
options object <nullable>
 axios http request options

CreateCluster(region, body, optionsnullable)

Source:
This method allows to create a new Kubernetes cluster on an account.
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
organization_id string The organization ID where the cluster will be created
project_id string The project ID where the cluster will be created
name string The name of the cluster
description string The description of the cluster
tags array The tags associated with the cluster
version string The Kubernetes version of the cluster
cni string The Container Network Interface (CNI) plugin that will run in the cluster
enable_dashboard boolean The enablement of the Kubernetes Dashboard in the cluster
ingress string The Ingress Controller that will run in the cluster
pools array The pools to be created along with the cluster
autoscaler_config object This field allows to specify some configuration for the autoscaler, which is an implementation of the [cluster-autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/).
auto_upgrade object This configuratiom enables to set a speicific 2-hour time window in which the cluster can be automatically updated to the latest patch version in the current minor one.
feature_gates array List of feature gates to enable
admission_plugins array List of admission plugins to enable
open_id_connect_config object This feature is in ALPHA state, it may be deleted or modified. This configuration enables to set the [OpenID Connect configuration](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens) of the Kubernetes API server.
options object <nullable>
 axios http request options

CreateDatabaseRoute(region, body, optionsnullable)

Source:
Create a route that will record subscribed MQTT messages into your database. You need to manage the database by yourself.
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Name of the route
hub_id string ID of the route's hub
topic string Topic the route subscribes to (wildcards allowed). It must be a valid MQTT topic and up to 65535 characters
query string SQL query to be executed ($TOPIC and $PAYLOAD variables are available, see documentation)
database object Database settings
options object <nullable>
 axios http request options

CreateDevice(region, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Device name
hub_id string ID of the device's hub
allow_insecure boolean Allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones
message_filters object Filter-sets to authorize or deny the device to publish/subscribe to specific topics
options object <nullable>
 axios http request options

CreateFrontend(region, lb_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
body object Request content
Properties
Name Type Description
name string Resource name
inbound_port number TCP port to listen on the front side
backend_id string Backend ID
timeout_client number Set the maximum inactivity time on the client side (in milliseconds)
certificate_id string Certificate ID, deprecated in favor of certificate_ids array !
certificate_ids array List of certificate IDs to bind on the frontend
options object <nullable>
 axios http request options

CreateHub(region, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Hub name (up to 255 characters)
organization_id string Organization owning the resource
product_plan string Hub feature set
disable_events boolean Disable Hub events (default false)
events_topic_prefix string Hub events topic prefix (default '$SCW/events')
options object <nullable>
 axios http request options

CreateImage(zone, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
name string Name of the image
root_volume string UUID of the snapshot
arch string Architecture of the image
default_bootscript string Default bootscript of the image
extra_volumes object Additional volumes of the image
organization string Organization ID of the image
project string Project ID of the image
public boolean True to create a public image
options object <nullable>
 axios http request options

CreateIp(zone, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
organization string The organization ID the IP is reserved in
project string The project ID the IP is reserved in
server string UUID of the server you want to attach the IP to
tags array An array of keywords you want to tag this IP with
options object <nullable>
 axios http request options

CreateIp(region, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
organization_id string Owner of resources
project_id string Assign the resource to a project ID
reverse string Reverse domain name
options object <nullable>
 axios http request options

CreateLb(region, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
organization_id string Owner of resources
project_id string Assign the resource to a project ID
name string Resource names
description string Resource description
ip_id string Just like for compute instances, when you destroy a load balancer, you can keep its highly available IP address and reuse it for another load balancer later
tags array List of keyword
type string Load balancer offer type
ssl_compatibility_level string Enforces minimal SSL version (in SSL/TLS offloading context). - `intermediate` General-purpose servers with a variety of clients, recommended for almost all systems (Supports Firefox 27, Android 4.4.2, Chrome 31, Edge, IE 11 on Windows 7, Java 8u31, OpenSSL 1.0.1, Opera 20, and Safari 9). - `modern` Services with clients that support TLS 1.3 and don't need backward compatibility (Firefox 63, Android 10.0, Chrome 70, Edge 75, Java 11, OpenSSL 1.1.1, Opera 57, and Safari 12.1). - `old` Compatible with a number of very old clients, and should be used only as a last resort (Firefox 1, Android 2.3, Chrome 1, Edge 12, IE8 on Windows XP, Java 6, OpenSSL 0.9.8, Opera 5, and Safari 1).
options object <nullable>
 axios http request options

CreateNamespace(region, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Define a namespace name
description string Define a description
organization_id string Assign the namespace owner (deprecated)
project_id string Assign the namespace to a project ID
is_public boolean Define the default visibility policy
options object <nullable>
 axios http request options

CreateNetwork(region, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Network name
organization_id string Will always be assigned to the organization owning the IoT hub.
type string Type of network to connect with
hub_id string Hub ID to connect the Network to
topic_prefix string Topic prefix for the Network
options object <nullable>
 axios http request options

CreatePlacementGroup(zone, body, optionsnullable)

Source:
Create a new placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
name string Name of the placement group
organization string Organization ID of the placement group
project string Project ID of the placement group
policy_mode string The operating mode of the placement group
policy_type string The policy type of the placement group
options object <nullable>
 axios http request options

CreatePool(region, cluster_id, body, optionsnullable)

Source:
This method allows to create a new pool in a specific Kubernetes cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster in which the pool will be created
body object Request content
Properties
Name Type Description
name string The name of the pool
node_type string The node type is the type of Scaleway Instance wanted for the pool
placement_group_id string The placement group ID in which all the nodes of the pool will be created
autoscaling boolean The enablement of the autoscaling feature for the pool
size number The size (number of nodes) of the pool
min_size number The minimun size of the pool. Note that this fields will be used only when autoscaling is enabled.
max_size number The maximum size of the pool. Note that this fields will be used only when autoscaling is enabled.
container_runtime string The customization of the container runtime is available for each pool. Note that `docker` is the only supporter runtime at the moment. Others are to be considered experimental.
autohealing boolean The enablement of the autohealing feature for the pool
tags array The tags associated with the pool
options object <nullable>
 axios http request options

CreatePrivateNetwork(zone, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
name string The name of the private network
project_id string The project ID of the private network
tags array The private networks tags
options object <nullable>
 axios http request options

CreatePrivateNIC(zone, server_id, body, optionsnullable)

Source:
Create a private NIC connecting a server to a private network.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string -
body object Request content
Properties
Name Type Description
private_network_id string -
options object <nullable>
 axios http request options

CreateRestRoute(region, body, optionsnullable)

Source:
Create a route that will call a REST API on received subscribed MQTT messages.
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Name of the route
hub_id string ID of the route's hub
topic string Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters
verb string HTTP Verb used to call REST URI
uri string URI of the REST endpoint
headers object HTTP call extra headers
options object <nullable>
 axios http request options

CreateS3Route(region, body, optionsnullable)

Source:
Create a route that will put subscribed MQTT messages into an S3 bucket. You need to create the bucket yourself and grant us write access: ```bash > s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031 ```
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Name of the route
hub_id string ID of the route's hub
topic string Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters
bucket_region string Region of the S3 route's destination bucket (eg 'fr-par')
bucket_name string Name of the S3 route's destination bucket
object_prefix string Optional string to prefix object names with
strategy string How the S3 route's objects will be created: one per topic or one per message
options object <nullable>
 axios http request options

CreateSecurityGroup(zone, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
name string Name of the security group
description string Description of the security group
organization string Organization ID the security group belongs to
project string Project ID the security group belong to
organization_default boolean Whether this security group becomes the default security group for new instances
project_default boolean Whether this security group becomes the default security group for new instances
stateful boolean Whether the security group is stateful or not
inbound_default_policy string Default policy for inbound rules
outbound_default_policy string Default policy for outbound rules
options object <nullable>
 axios http request options

CreateSecurityGroupRule(zone, security_group_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
security_group_id string UUID of the security group
body object Request content
Properties
Name Type Description
protocol object -
direction object -
action object -
ip_range string (IP network)
dest_port_from object -
dest_port_to object -
position number -
editable boolean -
options object <nullable>
 axios http request options

CreateServer(zone, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
name string The server name
dynamic_ip_required boolean Define if a dynamic IP is required for the instance
commercial_type string Define the server commercial type (i.e. GP1-S)
image string The server image ID
volumes object The volumes attached to the server
enable_ipv6 boolean True if IPv6 is enabled on the server
public_ip string The ID of the reserved IP to attach to the server
boot_type string The boot type to use
bootscript string The bootscript ID to use when `boot_type` is set to `bootscript`
organization string The server organization ID
project string The server project ID
tags array The server tags
security_group string The security group ID
placement_group string Placement group ID if server must be part of a placement group
options object <nullable>
 axios http request options

CreateServer(zone, body, optionsnullable)

Source:
Create a new baremetal server. Once the server is created, you probably want to install an OS.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
offer_id string Offer ID of the new server
organization_id string Organization ID with which the server will be created
project_id string Project ID with which the server will be created
name string Name of the server (≠hostname)
description string Description associated to the server, max 255 characters
tags array Tags to associate to the server
install object -
options object <nullable>
 axios http request options

CreateSnapshot(zone, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
name string Name of the snapshot
volume_id string UUID of the volume
organization string Organization ID of the snapshot
project string Project ID of the snapshot
options object <nullable>
 axios http request options

CreateSubscriber(region, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
body object Request content
Properties
Name Type Description
name string Subscriber name
email_config object Email address configuration
webhook_config object WebHook URI configuration
organization_id string Owner of resources
project_id string Assign the resource to a project ID
options object <nullable>
 axios http request options

CreateVolume(zone, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
body object Request content
Properties
Name Type Description
name string The volume name
organization string The volume organization ID
project string The volume project ID
volume_type string The volume type
size number The volume disk size (in bytes)
base_volume string The ID of the volume on which this volume will be based
base_snapshot string The ID of the snapshot on which this volume will be based
options object <nullable>
 axios http request options

DeleteAcl(region, acl_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
acl_id string ID of your ACL ressource
options object <nullable>
 axios http request options

DeleteBackend(region, backend_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
backend_id string ID of the backend to delete
options object <nullable>
 axios http request options

DeleteCertificate(region, certificate_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
certificate_id string Certificate ID
options object <nullable>
 axios http request options

DeleteCluster(region, cluster_id, optionsnullable)

Source:
This method allows to delete a specific cluster and all its associated pools and nodes. Note that this method will not delete any Load Balancers or Block Volumes that are associated with the cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster to delete
options object <nullable>
 axios http request options

DeleteDatabaseRoute(region, route_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
route_id string Route ID
options object <nullable>
 axios http request options

DeleteDevice(region, device_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
device_id string Device ID
options object <nullable>
 axios http request options

DeleteFrontend(region, frontend_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
frontend_id string Frontend ID to delete
options object <nullable>
 axios http request options

DeleteHub(region, hub_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
hub_id string Hub ID
options object <nullable>
 axios http request options

DeleteImage(zone, image_id, optionsnullable)

Source:
Delete the image with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
image_id string UUID of the image you want to delete
options object <nullable>
 axios http request options

DeleteImage(region, image_id, optionsnullable)

Source:
Delete the image associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
image_id string The unique ID of the Image
options object <nullable>
 axios http request options

DeleteIp(zone, ip, optionsnullable)

Source:
Delete the IP with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
ip string The ID or the address of the IP to delete
options object <nullable>
 axios http request options

DeleteLb(region, lb_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
options object <nullable>
 axios http request options

DeleteNamespace(region, namespace_id, optionsnullable)

Source:
Delete the namespace associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
namespace_id string The unique ID of the Namespace
options object <nullable>
 axios http request options

DeleteNetwork(region, network_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
network_id string Network ID
options object <nullable>
 axios http request options

DeletePlacementGroup(zone, placement_group_id, optionsnullable)

Source:
Delete the given placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
placement_group_id string UUID of the placement group you want to delete
options object <nullable>
 axios http request options

DeletePool(region, pool_id, optionsnullable)

Source:
This method allows to delete a specific pool from a cluster, deleting all the nodes associated with it.
Parameters:
Name Type Attributes Description
region string The region you want to target
pool_id string The ID of the pool to delete
options object <nullable>
 axios http request options

DeletePrivateNetwork(zone, private_network_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
private_network_id string The private network ID
options object <nullable>
 axios http request options

DeletePrivateNIC(zone, server_id, private_nic_id, optionsnullable)

Source:
Delete a private NIC.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string -
private_nic_id string -
options object <nullable>
 axios http request options

DeleteRestRoute(region, route_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
route_id string Route ID
options object <nullable>
 axios http request options

DeleteS3Route(region, route_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
route_id string Route ID
options object <nullable>
 axios http request options

DeleteSecurityGroup(zone, security_group_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
security_group_id string UUID of the security group you want to delete
options object <nullable>
 axios http request options

DeleteSecurityGroupRule(zone, security_group_id, security_group_rule_id, optionsnullable)

Source:
Delete a security group rule with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
security_group_id string -
security_group_rule_id string -
options object <nullable>
 axios http request options

DeleteServer(zone, server_id, optionsnullable)

Source:
Delete a server with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string -
options object <nullable>
 axios http request options

DeleteServer(zone, server_id, optionsnullable)

Source:
Delete the server associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server to delete
options object <nullable>
 axios http request options

DeleteServerUserData(zone, server_id, key, optionsnullable)

Source:
Delete the given key from a server user data.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string UUID of the server
key string Key of the user data to delete
options object <nullable>
 axios http request options

DeleteSnapshot(zone, snapshot_id, optionsnullable)

Source:
Delete the snapshot with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
snapshot_id string UUID of the snapshot you want to delete
options object <nullable>
 axios http request options

DeleteSubscriber(region, subscriber_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
subscriber_id string Subscriber ID
options object <nullable>
 axios http request options

DeleteTag(region, tag_id, optionsnullable)

Source:
Delete the tag associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
tag_id string The unique ID of the tag
options object <nullable>
 axios http request options

DeleteVolume(zone, volume_id, optionsnullable)

Source:
Delete the volume with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
volume_id string UUID of the volume you want to delete
options object <nullable>
 axios http request options

DetachPrivateNetwork(region, private_network_id, lb_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
private_network_id string -
lb_id string -
body object Request content
options object <nullable>
 axios http request options

DisableDevice(region, device_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
device_id string Device ID
options object <nullable>
 axios http request options

DisableHub(region, hub_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
hub_id string Hub ID
options object <nullable>
 axios http request options

EnableDevice(region, device_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
device_id string Device ID
options object <nullable>
 axios http request options

EnableHub(region, hub_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
hub_id string Hub ID
options object <nullable>
 axios http request options

GetAcl(region, acl_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
acl_id string ID of your ACL ressource
options object <nullable>
 axios http request options

GetBackend(region, backend_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
backend_id string Backend ID
options object <nullable>
 axios http request options

GetBMCAccess(zone, server_id, optionsnullable)

Source:
Get the BMC (Baseboard Management Controller) access associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server
options object <nullable>
 axios http request options

GetBootscript(zone, bootscript_id, optionsnullable)

Source:
Get details of a bootscript with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
bootscript_id string -
options object <nullable>
 axios http request options

GetCertificate(region, certificate_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
certificate_id string Certificate ID
options object <nullable>
 axios http request options

GetCluster(region, cluster_id, optionsnullable)

Source:
This method allows to get details about a specific Kubernetes cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the requested cluster
options object <nullable>
 axios http request options

GetClusterKubeConfig(region, cluster_id, optionsnullable)

Source:
This method allows to download the Kubernetes cluster config file (AKA kubeconfig) for a specific cluster in order to use it with, for instance, `kubectl`. Tips: add `?dl=1` at the end of the URL to directly get the base64 decoded kubeconfig. If not, the kubeconfig will be base64 encoded.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster to download the kubeconfig from
options object <nullable>
 axios http request options

GetDashboard(zone, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

GetDatabaseRoute(region, route_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
route_id string Route ID
options object <nullable>
 axios http request options

GetDevice(region, device_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
device_id string Device ID
options object <nullable>
 axios http request options

GetDeviceMetrics(region, device_id, period, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
device_id string Device ID
period string Period over which the metrics span
options object <nullable>
 axios http request options

GetFrontend(region, frontend_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
frontend_id string Frontend ID
options object <nullable>
 axios http request options

GetHub(region, hub_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
hub_id string Hub ID
options object <nullable>
 axios http request options

GetHubMetrics(region, hub_id, period, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
hub_id string Hub ID
period string Period over which the metrics span
options object <nullable>
 axios http request options

GetImage(zone, image_id, optionsnullable)

Source:
Get details of an image with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
image_id string UUID of the image you want to get
options object <nullable>
 axios http request options

GetImage(region, image_id, optionsnullable)

Source:
Get the image associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
image_id string The unique ID of the Image
options object <nullable>
 axios http request options

GetIp(zone, ip, optionsnullable)

Source:
Get details of an IP with the given ID or address.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
ip string The IP ID or address to get
options object <nullable>
 axios http request options

GetIp(region, ip_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
ip_id string IP address ID
options object <nullable>
 axios http request options

GetLb(region, lb_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
options object <nullable>
 axios http request options

GetLbStats(region, lb_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
options object <nullable>
 axios http request options

GetNamespace(region, namespace_id, optionsnullable)

Source:
Get the namespace associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
namespace_id string The unique ID of the Namespace
options object <nullable>
 axios http request options

GetNetwork(region, network_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
network_id string Network ID
options object <nullable>
 axios http request options

GetNode(region, node_id, optionsnullable)

Source:
This method allows to get details about a specific Kubernetes node.
Parameters:
Name Type Attributes Description
region string The region you want to target
node_id string The ID of the requested node
options object <nullable>
 axios http request options

GetOffer(zone, offer_id, optionsnullable)

Source:
Return specific offer for the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
offer_id string ID of the researched Offer
options object <nullable>
 axios http request options

GetOS(zone, os_id, optionsnullable)

Source:
Return specific OS for the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
os_id string ID of the OS
options object <nullable>
 axios http request options

GetPlacementGroup(zone, placement_group_id, optionsnullable)

Source:
Get the given placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
placement_group_id string UUID of the placement group you want to get
options object <nullable>
 axios http request options

GetPlacementGroupServers(zone, placement_group_id, optionsnullable)

Source:
Get all servers belonging to the given placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
placement_group_id string -
options object <nullable>
 axios http request options

GetPool(region, pool_id, optionsnullable)

Source:
This method allows to get details about a specific pool.
Parameters:
Name Type Attributes Description
region string The region you want to target
pool_id string The ID of the requested pool
options object <nullable>
 axios http request options

GetPrivateNetwork(zone, private_network_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
private_network_id string The private network id
options object <nullable>
 axios http request options

GetPrivateNIC(zone, server_id, private_nic_id, optionsnullable)

Source:
Get private NIC properties.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string -
private_nic_id string -
options object <nullable>
 axios http request options

GetRestRoute(region, route_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
route_id string Route ID
options object <nullable>
 axios http request options

GetS3Route(region, route_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
route_id string Route ID
options object <nullable>
 axios http request options

GetSecurityGroup(zone, security_group_id, optionsnullable)

Source:
Get the details of a Security Group with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
security_group_id string UUID of the security group you want to get
options object <nullable>
 axios http request options

GetSecurityGroupRule(zone, security_group_id, security_group_rule_id, optionsnullable)

Source:
Get details of a security group rule with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
security_group_id string -
security_group_rule_id string -
options object <nullable>
 axios http request options

GetServer(zone, server_id, optionsnullable)

Source:
Get the details of a specified Server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string UUID of the server you want to get
options object <nullable>
 axios http request options

GetServer(zone, server_id, optionsnullable)

Source:
Get the server associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server
options object <nullable>
 axios http request options

GetServerMetrics(zone, server_id, optionsnullable)

Source:
Give the ping status on the server associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string Server ID to get the metrics
options object <nullable>
 axios http request options

GetServerTypesAvailability(zone, optionsnullable)

Source:
Get availibility for all server types.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

GetServerUserData(zone, server_id, key, optionsnullable)

Source:
Get the content of a user data with the given key on a server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string UUID of the server
key string Key of the user data to get
options object <nullable>
 axios http request options

GetSnapshot(zone, snapshot_id, optionsnullable)

Source:
Get details of a snapshot with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
snapshot_id string UUID of the snapshot you want to get
options object <nullable>
 axios http request options

GetSubscriber(region, subscriber_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
subscriber_id string Subscriber ID
options object <nullable>
 axios http request options

GetTag(region, tag_id, optionsnullable)

Source:
Get the tag associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
tag_id string The unique ID of the Tag
options object <nullable>
 axios http request options

GetVersion(region, version_name, optionsnullable)

Source:
This method allows to get a specific Kubernetes version and the details about the version.
Parameters:
Name Type Attributes Description
region string The region you want to target
version_name string The requested version name
options object <nullable>
 axios http request options

GetVolume(zone, volume_id, optionsnullable)

Source:
Get details of a volume with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
volume_id string UUID of the volume you want to get
options object <nullable>
 axios http request options

InstallServer(zone, server_id, body, optionsnullable)

Source:
Install an OS on the server associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string Server ID to install
body object Request content
Properties
Name Type Description
os_id string ID of the OS to install on the server
hostname string Hostname of the server
ssh_key_ids array SSH key IDs authorized on the server
options object <nullable>
 axios http request options

ListAcls(region, frontend_id, page, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
frontend_id string ID of your frontend
page number Page number
options object <nullable>
 axios http request options

ListBackends(region, lb_id, page, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
page number Page number
options object <nullable>
 axios http request options

ListBackendStats(region, lb_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
options object <nullable>
 axios http request options

ListBootscripts(zone, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListCertificates(region, lb_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
options object <nullable>
 axios http request options

ListClusterAvailableVersions(region, cluster_id, optionsnullable)

Source:
This method allows to list the versions that a specific Kubernetes cluster is allowed to upgrade to. Note that it will be every patch version greater than the actual one as well a one minor version ahead of the actual one. Upgrades skipping a minor version will not work.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster which the available Kuberentes versions will be listed from
options object <nullable>
 axios http request options

ListClusters(region, optionsnullable)

Source:
This method allows to list all the existing Kubernetes clusters in an account.
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListDevices(region, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListFrontends(region, lb_id, page, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
page number Page number
options object <nullable>
 axios http request options

ListHubs(region, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListImages(zone, optionsnullable)

Source:
List all images available in an account.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListImages(region, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListIps(zone, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListIPs(region, page, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
page number Page number
options object <nullable>
 axios http request options

ListLbPrivateNetworks(region, lb_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string -
options object <nullable>
 axios http request options

ListLbs(region, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListLbTypes(region, page, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
page number Page number
options object <nullable>
 axios http request options

ListNamespaces(region, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListNetworks(region, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListNodes(region, cluster_id, optionsnullable)

Source:
This method allows to list all the existing nodes for a specific Kubernetes cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The cluster ID from which the nodes will be listed from
options object <nullable>
 axios http request options

ListOffers(zone, optionsnullable)

Source:
List all available server offers.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListOS(zone, optionsnullable)

Source:
List all available OS that can be install on a baremetal server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListPlacementGroups(zone, optionsnullable)

Source:
List all placement groups.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListPools(region, cluster_id, optionsnullable)

Source:
This method allows to list all the existing pools for a specific Kubernetes cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster from which the pools will be listed from
options object <nullable>
 axios http request options

ListPrivateNetworks(zone, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListPrivateNICs(zone, server_id, optionsnullable)

Source:
List all private NICs of a given server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string -
options object <nullable>
 axios http request options

ListRoutes(region, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListSecurityGroupRules(zone, security_group_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
security_group_id string UUID of the security group
options object <nullable>
 axios http request options

ListSecurityGroups(zone, optionsnullable)

Source:
List all security groups available in an account.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListServerActions(zone, server_id, optionsnullable)

Source:
Liste all actions that can currently be performed on a server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string -
options object <nullable>
 axios http request options

ListServerEvents(zone, server_id, optionsnullable)

Source:
List events associated to the given server ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server events searched
options object <nullable>
 axios http request options

ListServers(zone, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListServers(zone, optionsnullable)

Source:
List baremetal servers for organization.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListServersTypes(zone, optionsnullable)

Source:
Get server types technical details.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListServerUserData(zone, server_id, optionsnullable)

Source:
List all user data keys registered on a given server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string UUID of the server
options object <nullable>
 axios http request options

ListSnapshots(zone, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListSubscriber(region, page, name, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
page number Page number
name string Use this to search by name
options object <nullable>
 axios http request options

ListTags(region, image_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
image_id string The unique ID of the image
options object <nullable>
 axios http request options

ListVersions(region, optionsnullable)

Source:
This method allows to list all available versions for the creation of a new Kubernetes cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
options object <nullable>
 axios http request options

ListVolumes(zone, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

ListVolumesTypes(zone, optionsnullable)

Source:
Get volumes technical details.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
options object <nullable>
 axios http request options

MigrateLb(region, lb_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
body object Request content
Properties
Name Type Description
type string Load balancer type (check /lb-types to list all type)
options object <nullable>
 axios http request options

RebootNode(region, node_id, body, optionsnullable)

Source:
This method allows to reboot a specific node. This node will frist be cordoned, meaning that scheduling will be disabled. Then the existing pods on the node will be drained and reschedule onto another schedulable node. Note that when there is not enough space to reschedule all the pods (in a one node cluster for instance), you may experience some disruption of your applications.
Parameters:
Name Type Attributes Description
region string The region you want to target
node_id string The ID of the node to reboot
body object Request content
options object <nullable>
 axios http request options

RebootServer(zone, server_id, body, optionsnullable)

Source:
Reboot the server associated with the given ID, use boot param to reboot in rescue.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server to reboot
body object Request content
Properties
Name Type Description
boot_type string The type of boot
options object <nullable>
 axios http request options

ReleaseIp(region, ip_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
ip_id string IP address ID
options object <nullable>
 axios http request options

RemoveBackendServers(region, backend_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
backend_id string Backend ID
options object <nullable>
 axios http request options

ReplaceNode(region, node_id, body, optionsnullable)

Source:
This method allows to replace a specific node. The node will be set cordoned, meaning that scheduling will be disabled. Then the existing pods on the node will be drained and reschedule onto another schedulable node. Then the node will be deleted, and a new one will be created after the deletion. Note that when there is not enough space to reschedule all the pods (in a one node cluster for instance), you may experience some disruption of your applications.
Parameters:
Name Type Attributes Description
region string The region you want to target
node_id string The ID of the node to replace
body object Request content
options object <nullable>
 axios http request options

ResetClusterAdminToken(region, cluster_id, body, optionsnullable)

Source:
This method allows to reset the admin token for a specific Kubernetes cluster. This will invalidate the old admin token (which will not be usable after) and create a new one. Note that the redownload of the kubeconfig will be necessary to keep interacting with the cluster (if the old admin token was used).
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster of which the admin token will be renewed
body object Request content
options object <nullable>
 axios http request options

ServerAction(zone, server_id, body, optionsnullable)

Source:
Perform power related actions on a server. Be wary that when terminating a server, all the attached volumes (local *and* block storage) are deleted. So, if you want to keep your local volumes, you must use the `archive` action instead of `terminate`. And if you want to keep block-storage volumes, **you must** detach it beforehand you issue the `terminate` call. For more information, read the [Volumes](#volumes-7e8a39) documentation.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string UUID of the server
body object Request content
Properties
Name Type Description
action string The action to perform on the server
name string The name of the backup you want to create. This field should only be specified when performing a backup action.
options object <nullable>
 axios http request options

SetBackendServers(region, backend_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
backend_id string Backend ID
body object Request content
Properties
Name Type Description
server_ip array Set all IPs to add on your backend and remove all other
options object <nullable>
 axios http request options

SetImage(zone, id, body, optionsnullable)

Source:
Replace all image properties with an image message.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
id string -
body object Request content
Properties
Name Type Description
name string -
arch object -
creation_date object -
modification_date object -
default_bootscript object -
extra_volumes object -
from_server string -
organization string -
public boolean -
root_volume object -
state object -
project string -
options object <nullable>
 axios http request options

SetPlacementGroup(zone, placement_group_id, body, optionsnullable)

Source:
Set all parameters of the given placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
placement_group_id string -
body object Request content
Properties
Name Type Description
name string -
organization string -
policy_mode object -
policy_type object -
project string -
options object <nullable>
 axios http request options

SetPlacementGroupServers(zone, placement_group_id, body, optionsnullable)

Source:
Set all servers belonging to the given placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
placement_group_id string -
body object Request content
Properties
Name Type Description
servers array -
options object <nullable>
 axios http request options

SetSecurityGroup(zone, id, body, optionsnullable)

Source:
Replace all security group properties with a security group message.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
id string The ID of the security group (will be ignored)
body object Request content
Properties
Name Type Description
name string The name of the security group
creation_date string The creation date of the security group (will be ignored)
modification_date string The modification date of the security group (will be ignored)
description string The description of the security group
enable_default_security boolean True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please open a ticket if you need to make it configurable.
inbound_default_policy string The default inbound policy
outbound_default_policy string The default outbound policy
organization string The security groups organization ID
project string The security group project ID
organization_default boolean Please use project_default instead
project_default boolean True use this security group for future instances created in this project
servers array The servers attached to this security group
stateful boolean True to set the security group as stateful
options object <nullable>
 axios http request options

SetSecurityGroupRule(zone, security_group_id, security_group_rule_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
security_group_id string -
security_group_rule_id string -
body object Request content
Properties
Name Type Description
id string -
protocol object -
direction object -
action object -
ip_range string (IP network)
dest_port_from object -
dest_port_to object -
position number -
editable boolean -
options object <nullable>
 axios http request options

SetServerUserData(zone, server_id, key, optionsnullable)

Source:
Add or update a user data with the given key on a server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string UUID of the server
key string Key of the user data to set
options object <nullable>
 axios http request options

SetSnapshot(zone, id, body, optionsnullable)

Source:
Replace all snapshot properties with a snapshot message.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
id string -
body object Request content
Properties
Name Type Description
name string -
organization string -
volume_type object -
size number (in bytes)
state object -
base_volume object -
creation_date object -
modification_date object -
project string -
options object <nullable>
 axios http request options

SetVolume(zone, id, body, optionsnullable)

Source:
Replace all volume properties with a volume message.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
id string The volumes unique ID
body object Request content
Properties
Name Type Description
name string The volumes names
export_uri string Show the volumes NBD export URI
size number The volumes disk size (in bytes)
volume_type string The volumes type
creation_date string The volumes creation date
modification_date string The volumes modification date
organization string The volumes organization ID
project string The volumes project ID
server object The server attached to the volume
state string The volumes state
options object <nullable>
 axios http request options

StartBMCAccess(zone, server_id, body, optionsnullable)

Source:
Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server
body object Request content
Properties
Name Type Description
ip string The IP authorized to connect to the given server (IPv4 address)
options object <nullable>
 axios http request options

StartServer(zone, server_id, body, optionsnullable)

Source:
Start the server associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server to start
body object Request content
Properties
Name Type Description
boot_type string The type of boot
options object <nullable>
 axios http request options

StopBMCAccess(zone, server_id, optionsnullable)

Source:
Stop BMC (Baseboard Management Controller) access associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server
options object <nullable>
 axios http request options

StopServer(zone, server_id, body, optionsnullable)

Source:
Stop the server associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server to stop
body object Request content
options object <nullable>
 axios http request options

SubscribeToLb(region, lb_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
body object Request content
Properties
Name Type Description
subscriber_id string Subscriber ID
options object <nullable>
 axios http request options

UnsubscribeFromLb(region, lb_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
options object <nullable>
 axios http request options

UpdateAcl(region, acl_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
acl_id string ID of your ACL ressource
body object Request content
Properties
Name Type Description
name string Name of your ACL ressource
action object Action to undertake when an ACL filter matches
match object The ACL match rule. At least `ip_subnet` or `http_filter` and `http_filter_value` are required
index number Order between your Acls (ascending order, 0 is first acl executed)
options object <nullable>
 axios http request options

UpdateBackend(region, backend_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
backend_id string -
body object Request content
Properties
Name Type Description
name string -
forward_protocol object -
forward_port number -
forward_port_algorithm object -
sticky_sessions object -
sticky_sessions_cookie_name string -
send_proxy_v2 boolean -
timeout_server number (in milliseconds)
timeout_connect number (in milliseconds)
timeout_tunnel number (in milliseconds)
on_marked_down_action object -
proxy_protocol object -
options object <nullable>
 axios http request options

UpdateCertificate(region, certificate_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
certificate_id string Certificate ID
body object Request content
Properties
Name Type Description
name string Certificate name
options object <nullable>
 axios http request options

UpdateCluster(region, cluster_id, optionsnullable)

Source:
This method allows to update a specific Kubernetes cluster. Note that this method is not made to upgrade a Kubernetes cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster to update
options object <nullable>
 axios http request options

UpdateDevice(region, device_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
device_id string Device ID
options object <nullable>
 axios http request options

UpdateFrontend(region, frontend_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
frontend_id string Frontend ID
body object Request content
Properties
Name Type Description
name string Resource name
inbound_port number TCP port to listen on the front side
backend_id string Backend ID
timeout_client number Client session maximum inactivity time (in milliseconds)
certificate_id string Certificate ID, deprecated in favor of `certificate_ids` array!
certificate_ids array List of certificate IDs to bind on the frontend
options object <nullable>
 axios http request options

UpdateHealthCheck(region, backend_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
backend_id string Backend ID
body object Request content
Properties
Name Type Description
port number Specify the port used to health check
check_delay number Time between two consecutive health checks (in milliseconds)
check_timeout number Additional check timeout, after the connection has been already established (in milliseconds)
check_max_retries number Number of consecutive unsuccessful health checks, after wich the server will be considered dead
mysql_config object The check requires MySQL >=3.22, for older version, please use TCP check
ldap_config object The response is analyzed to find an LDAPv3 response message
redis_config object The response is analyzed to find the +PONG response message
pgsql_config object -
tcp_config object -
http_config object -
https_config object -
options object <nullable>
 axios http request options

UpdateHub(region, hub_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
hub_id string Hub ID
options object <nullable>
 axios http request options

UpdateImage(region, image_id, optionsnullable)

Source:
Update the image associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
image_id string Image ID to update
options object <nullable>
 axios http request options

UpdateIp(zone, ip, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
ip string IP ID or IP address
options object <nullable>
 axios http request options

UpdateIP(zone, server_id, ip_id, optionsnullable)

Source:
Configure ip associated with the given server ID and ipID. You can use this method to set a reverse dns for an IP.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server
ip_id string ID of the IP to update
options object <nullable>
 axios http request options

UpdateIp(region, ip_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
ip_id string IP address ID
options object <nullable>
 axios http request options

UpdateLb(region, lb_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
lb_id string Load balancer ID
body object Request content
Properties
Name Type Description
name string Resource name
description string Resource description
tags array List of keywords
ssl_compatibility_level string Enforces minimal SSL version (in SSL/TLS offloading context). - `intermediate` General-purpose servers with a variety of clients, recommended for almost all systems (Supports Firefox 27, Android 4.4.2, Chrome 31, Edge, IE 11 on Windows 7, Java 8u31, OpenSSL 1.0.1, Opera 20, and Safari 9). - `modern` Services with clients that support TLS 1.3 and don't need backward compatibility (Firefox 63, Android 10.0, Chrome 70, Edge 75, Java 11, OpenSSL 1.1.1, Opera 57, and Safari 12.1). - `old` Compatible with a number of very old clients, and should be used only as a last resort (Firefox 1, Android 2.3, Chrome 1, Edge 12, IE8 on Windows XP, Java 6, OpenSSL 0.9.8, Opera 5, and Safari 1).
options object <nullable>
 axios http request options

UpdateNamespace(region, namespace_id, optionsnullable)

Source:
Update the namespace associated with the given id.
Parameters:
Name Type Attributes Description
region string The region you want to target
namespace_id string Namespace ID to update
options object <nullable>
 axios http request options

UpdatePlacementGroup(zone, placement_group_id, optionsnullable)

Source:
Update one or more parameter of the given placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
placement_group_id string UUID of the placement group
options object <nullable>
 axios http request options

UpdatePlacementGroupServers(zone, placement_group_id, optionsnullable)

Source:
Update all servers belonging to the given placement group.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
placement_group_id string UUID of the placement group
options object <nullable>
 axios http request options

UpdatePool(region, pool_id, optionsnullable)

Source:
This method allows to update some attributes of a specific pool such as the size, the autoscaling enablement, the tags, ...
Parameters:
Name Type Attributes Description
region string The region you want to target
pool_id string The ID of the pool to update
options object <nullable>
 axios http request options

UpdatePrivateNetwork(zone, private_network_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
private_network_id string The private network ID
options object <nullable>
 axios http request options

UpdateServer(zone, server_id, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string UUID of the server
options object <nullable>
 axios http request options

UpdateServer(zone, server_id, optionsnullable)

Source:
Update the server associated with the given ID.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
server_id string ID of the server to update
options object <nullable>
 axios http request options

UpdateSubscriber(region, subscriber_id, body, optionsnullable)

Source:
undefined
Parameters:
Name Type Attributes Description
region string The region you want to target
subscriber_id string Assign the resource to a project IDs
body object Request content
Properties
Name Type Description
name string Subscriber name
email_config object Email address configuration
webhook_config object WebHook URI configuration
options object <nullable>
 axios http request options

UpdateVolume(zone, volume_id, optionsnullable)

Source:
Replace name and/or size properties of given ID volume with the given value(s). Any volume name can be changed while, for now, only `b_ssd` volume growing is supported.
Parameters:
Name Type Attributes Description
zone string The zone you want to target
volume_id string UUID of the volume
options object <nullable>
 axios http request options

UpgradeCluster(region, cluster_id, body, optionsnullable)

Source:
This method allows to upgrade a specific Kubernetes cluster and/or its associated pools to a specific and supported Kubernetes version.
Parameters:
Name Type Attributes Description
region string The region you want to target
cluster_id string The ID of the cluster to upgrade
body object Request content
Properties
Name Type Description
version string The new Kubernetes version of the cluster. Note that the version shoud either be a higher patch version of the same minor version or the direct minor version after the current one.
upgrade_pools boolean This field makes the upgrade upgrades the pool once the Kubernetes master in upgrade.
options object <nullable>
 axios http request options

UpgradePool(region, pool_id, body, optionsnullable)

Source:
This method allows to upgrade the Kubernetes version of a specific pool. Note that this will work when the targeted version is the same than the version of the cluster.
Parameters:
Name Type Attributes Description
region string The region you want to target
pool_id string The ID of the pool to upgrade
body object Request content
Properties
Name Type Description
version string The new Kubernetes version for the pool
options object <nullable>
 axios http request options