README

Scaleway Instances are virtual machines in the cloud. Different Instance types offer different technical specifications in terms of vCPU, RAM, bandwidth and storage. Once you have created your Instance and installed your image of choice (e.g. an operating system), you can connect to your Instance via SSH to use it as you wish. When you are done using the Instance, you can delete it from your account.

(switchcolumn) <Message type="tip"> To retrieve information about the different images available to install on Scaleway Instances, check out our Marketplace API. (switchcolumn)

Concepts

Refer to our dedicated concepts page to find definitions of all concepts and terminology related to Instances.

(switchcolumn) (switchcolumn)

Quickstart

Configure your environment variables

<Message type="note"> This is an optional step that seeks to simplify your usage of the Instances API. See Availability Zones below for help choosing an Availability Zone. You can find your Project ID in the Scaleway console.
```
export SCW_SECRET_KEY=\"<API secret key>\"
export SCW_DEFAULT_ZONE=\"<Scaleway Availability Zone>\"
export SCW_PROJECT_ID=\"<Scaleway Project ID>\"
```
Create an Instance: Run the following command to create an Instance. You can customize the details in the payload (name, description, type, tags etc) to your needs: use the information below to adjust the payload as necessary.
```
curl -X POST \\
  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\
  -H \"Content-Type: application/json\" \\
  \"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers\" \\
    -d '{
      \"name\": \"my-new-instance\", 
      \"project\": \"'\"$SCW_PROJECT_ID\"'\",
      \"commercial_type\": \"GP1-S\", 
      \"image\": \"544f0add-626b-4e4f-8a96-79fa4414d99a\",
      \"enable_ipv6\": true,
      \"volumes\": {
        \"0\":{
          \"name\": \"my-volume\",
          \"size\": 300000000000,
          \"volume_type\": \"l_ssd\"
        }
      }
    }'
```
```
 | Parameter       | Description                                                                                                                                              | Valid values                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
```
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name | A name of your choice for the Instance (string) | Any string containing only alphanumeric characters, dots, spaces and dashes, e.g. \"my-new-instance\". | | project | The Project in which the Instance should be created (string) | Any valid Scaleway Project ID (see above), e.g. \"b4bd99e0-b389-11ed-afa1-0242ac120002\" | | commercial-type | The commercial Instance type to create (string) | Any valid ID of a Scaleway commercial Instance type, e.g. \"GP1-S\", \"PRO2-M\". Use the List Instance Types endpoint to get a list of all valid Instance types and their IDs. | | image | The image to install on the Instance, e.g. a particular OS (string) | Any valid Scaleway image ID, e.g. \"544f0add-626b-4e4f-8a96-79fa4414d99a\" which is the ID for the Ubuntu 22.04 Jammy Jellyfish image. Use the List Instance Images endpoint to get a list of all available images and their IDs, or check out the Scaleway Marketplace API. | | enable_ipv6 | Whether to enable IPv6 on the Instance (boolean) | true or false | | volumes | An object that specifies the storage volumes to attach to the Instance. For more information, see Creating an Instance: the volumes object in the Technical information section of this quickstart. | A (dictionary) object with a minimum of one key (\"0\") whose value is another object containing the parameters \"name\" (a name for the volume), \"size\" (the size for the volume, in bytes), and \"volume_type\" (\"l_ssd\", \"b_ssd\" or \"unified\"). Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of 1.) Further parameters are available, and it is possible to attach existing volumes rather than creating a new one, or create a volume from a snapshot. |

List your Instances: run the following command to get a list of all the Instances in your account, with their details:

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

Delete an Instance: run the following command to delete an Instance, specified by its Instance ID:

curl -X DELETE \\
  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\
  -H \"Content-Type: application/json\" \\
  \"https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_ZONE/servers/<Instance-ID>\"

The expected successful response is empty.

(switchcolumn) <Message type="requirement">

You have a Scaleway account
You have created an API key and that the API key has sufficient IAM permissions to perform the actions described on this page
You have installed curl

(switchcolumn)

Technical information

Availability Zones

Instances can be deployed in the following Availability Zones:

(switchcolumn) (switchcolumn)

Pagination

Most listing requests receive a paginated response. Requests against paginated endpoints accept two query arguments:

page, a positive integer to choose which page to return.
per_page, an positive integer lower or equal to 100 to select the number of items to return per page. The default value is 50.

Paginated endpoints usually also accept filters to search and sort results.These filters are documented along each endpoint documentation.

The X-Total-Count header contains the total number of items returned.

(switchcolumn) (switchcolumn)

Creating an Instance: the volumes object

When creating an Instance, the volumes object is a required part of the payload. This is a dictionary with a minimum of one key (\"0\") whose value is another object setting parameters for that volume. Additional keys for additional volumes should increment by 1 each time (the second volume would have a key of 1.)

Note that volume size must respect the volume constraints of the Instance's commercial_type: for each type of Instance, a minimum amount of storage is required, and there is also a maximum that cannot be exceeded. Some Instance types support only Block Storage (b_ssd), others also support local storage (l_ssd) ). Read more about these constraints in the List Instance types documentation, specifically the volume_constraints parameter for each type listed in the response

You can use the volumes object in different ways. The table below shows which parameters are required for each of the following use cases:

(switchcolumn) <Message type="note"> This information is designed to help you correctly configure the volumes object when using the Create an Instance or Update an Instance methods. (switchcolumn)

Going further

For more help using Scaleway Instances, check out the following resources:

Our main documentation
The #instance channel on our Slack Community
Our support ticketing system.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: scaleway
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Auth-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\BootscriptsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$zone = 'zone_example'; // string | The zone you want to target
$bootscript_id = 'bootscript_id_example'; // string

try {
    $result = $apiInstance->getBootscript($zone, $bootscript_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BootscriptsApi->getBootscript: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.scaleway.com

Models

Authorization

Authentication schemes defined for the API:

scaleway

Type: API key
API key parameter name: X-Auth-Token
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: v1
Build package: org.openapitools.codegen.languages.PhpClientCodegen

kanta-inc / scaleway-php-client

Maintainers

Details

README

Concepts

Quickstart

Technical information

Availability Zones

Pagination

Creating an Instance: the volumes object

Going further

Installation & Usage

Requirements

Composer

Manual Installation

Getting Started

API Endpoints

Models

Authorization

scaleway

Tests

Author

About this package