---
title: How to use Postman to manage Scaleway APIs
description: This page shows how to import APIs into Postman, configure your environment variables and authentication, and share your workspace with other users.
tags: postman api json
products:
  - instances
  - iot-hub
dates:
  validation: 2026-02-17
  posted: 2022-03-24
  validation_frequency: 12
difficulty: beginner
usecase:
  - best-practices
ecosystem:
  - third-party
---
import image from './assets/scaleway-postman-create-workspace.webp'
import image2 from './assets/scaleway-postman-download-open-api.webp'
import image3 from './assets/scaleway-postman-import.webp'
import image4 from './assets/scaleway-postman-add-variables.webp'
import image6 from './assets/scaleway-postman-select-environment.webp'
import image7 from './assets/scaleway-postman-endpoint.webp'
import image8 from './assets/scaleway-postman-response.webp'

import Requirements from '@macros/iam/requirements.mdx'


Postman is an API client that allows you to build, test, and manage APIs through a graphical interface. The platform includes features that make it easy for you to:
  - Create, import, and test APIs
  - Work collaboratively with other users
  - Create different environments with unique variables
  - Display responses in several programming languages
  - Configure granular request authorization rules, using different authorization types
  - Capture and monitor request data (status, time, size)

In this tutorial, you will learn how to import Scaleway APIs into Postman, configure your environment variables and authentication, and share your workspace with other users.

<Requirements />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/)
- An account logged into [Postman](https://www.postman.com/postman-account/)

## Importing Scaleway APIs into Postman

1. Click **Workspaces** > **Create Workspace** in the top menu of the Postman interface.
    <Lightbox image={image} />
2. Enter a name and description and select a visibility setting for your workspace. Your workspace displays.
3. Go to the Scaleway [Developers website](https://www.scaleway.com/en/developers/) and select a product API to download.

    In this tutorial, we use the [Scaleway Instances API](https://www.scaleway.com/en/developers/api/instances/).
4. Click **Download OpenAPI**.
    <Lightbox image={image2} />
5. Click **Collections** > **Import** in the side menu of the Postman interface.
    <Lightbox image={image3} />
6. Drag and drop the Instance's Open API `yml` file into the indicated space to upload.
7. Click **Import** to conclude.

  The Instances API displays under the **Collections** tab in the side menu. The API is organized into files, following the different request categories (including servers, images, placement groups, and IPs).

## Setting up an environment

Postman environments are sets of key/value pairs. They are spaces in which you can store your authentication information to use as variables with your collections.

In this section, we show you how to create an environment with environment variables for a Scaleway Project.

1. Click **Create Environment**.
2. Enter a name for your environment.
3. Configure your variables, as follows:
    - **Variable** - enter the key for your variable.
    - **Type** - Select `default` to make it visible in plaintext or `secret` to mask the values on the screen.
    - **Initial value** - The value shown to other users when you share the variable in a collection, environment, or globals.
    - **Current value** - The value used when you send a request.

    You can add your Project ID, its access key, and secret key. We recommend you set your Project's secret key as **secret** to increase security.

    <Lightbox image={image4} />
4. Click **Save** to do so.

## Setting up authorization

You can set up authorization at the collection, request category, and/or request level. In this tutorial, we will set the authorization at the collection level and configure the requests to inherit the setting from the parent.

1. Go to the **Collections** tab.
2. Click on the Instance API collection. The **Authorization** tab displays by default.
    <Lightbox image='scaleway-postman-authorization-display.webp' />
3. Select your environment from the top-right menu.
    <Lightbox image={image6} />
4. Select **API key** as the authorization type.
5. Enter the following values:
    - Key: `X-Auth-Token`
    - Value: `{{SCW_SECRET_KEY}}` - this is the variable you set up in your environment.
    - Add to: `Header`
6. Click **Save**.
7. Go to your request of choice.
8. Click the **Authorization** tab.
9. Select **Inherit auth from parent** as the authorization type.

## Running a request

In this tutorial, we will create an Instance through an API request operated with Postman.

1. Go to the **Collections** tab of the Postman interface.
2. Click the **Create a server** request under **Instance API** > `/instance/v1/zones/{zone}/servers/`.
3. Go to the **Body** tab of the request.
4. Edit the `{zone}` variable in the endpoint. In this tutorial, we will create our Instance in `fr-par-1`.
    <Lightbox image={image7} />

    <Message type="tip">
      If you always create resources in the same region, you can [set up a variable](/tutorials/postman-api/#setting-up-an-environment) for the zone in your environment.
    </Message>
5. Edit the parameters in the request with your preferences, following the example below. In this tutorial, we will create a GP1-M Instance with the default local volume.
    <Message type="note">
      - For more information on how to fill out the parameters, refer to the [Scaleway Developers website](https://www.scaleway.com/en/developers/api/instances/#path-instances-create-an-instance).
      - To find the image UUID, [follow this procedure](/instances/faq/#what-is-a-marketplace-image).
    </Message>

    ```json
    {
      "name": "my-new-instance",
      "commercial_type": "DEV1-S",
      "image": "881d7a33-4cfa-4046-b5cf-c33cb9c62fb6",
      "enable_ipv6": false,
      "boot_type": "local",
      "project": "697ef834-9bd0-4181-ae29-b0bcd0e574ae"
    }
    ```
6. Click **Send**.
    <Lightbox image={image8} />

Optionally, click **Save** to store your configuration for future use.

## Going further

Postman also features a Command Line Interface (CLI) called `newman`, which you can use to run your collections. [Find out more about newman](https://github.com/postmanlabs/newman).

For more information on Postman usage and features, refer to the [Postman Learning Center](https://learning.postman.com/docs/getting-started/introduction/).