@scaleway/sdk-instance


Scaleway SDK for Instance API.

> Note
> This is an automatically generated package that is part of the Scaleway SDK for JavaScript.

Installation

``bash
npm install @scaleway/sdk-instance @scaleway/sdk-client
`

or with pnpm:

`bash
pnpm add @scaleway/sdk-instance @scaleway/sdk-client
`

or with yarn:

`bash
yarn add @scaleway/sdk-instance @scaleway/sdk-client
`

Getting Started

You'll need a pair of access and secret keys to connect to Scaleway API. Please check the documentation on how to retrieve them.

$3

`typescript
import { createClient } from '@scaleway/sdk-client'
import { Instance } from '@scaleway/sdk-instance'

const client = createClient({
accessKey: 'SCWXXXXXXXXXXXXXXXXX',
secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
defaultRegion: 'fr-par',
defaultZone: 'fr-par-1',
})

const api = new Instance.v1.API(client)

// Use the API
// Example: await api.listServers()
`

$3

For a simpler setup, you can load credentials from the configuration file or environment variables:

`typescript
import { createClient } from '@scaleway/sdk-client'
import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
import { Instance } from '@scaleway/sdk-instance'

const profile = loadProfileFromConfigurationFile()
const client = createClient(profile)
const api = new Instance.v1.API(client)
``

Documentation

- 📚 Scaleway SDK Reference Documentation
- 🌐 Scaleway Instance API Documentation
- 📖 Main Repository
- 💡 Example Projects

Features

- ✅ Full TypeScript support with complete type definitions
- ✅ Promise-based API
- ✅ Automatic pagination helpers
- ✅ Built-in error handling
- ✅ Compatible with Node.js ≥ 20

Support

We love feedback! Feel free to reach us on:
- Scaleway Slack community - Join us on #opensource
- GitHub Issues

Contributing

This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read CONTRIBUTING.md.

License

This project is Apache 2.0 licensed. See the LICENSE file for details.