Account APIv2

Download OpenAPI

Introduction

Scaleway is a complete cloud ecosystem offering a one-stop solution for creating, deploying and scaling your infrastructure. When you create your Scaleway account, you get instant access to the Scaleway console and Scaleway API to effortlessly deploy our products and services.

The Account API currently allows you to manage Projects. Projects are Scaleway's resource management feature. Designed to help you manage your infrastructure and cloud services, you can create multiple Projects within a single Organization. This allows you to group resources into different Projects, providing better resource isolation and organization, which, in turn, leads to improved management efficiency.

It also increases transparency for users since resources in an invoice are grouped into Projects. Additionally, access for each Scaleway product is managed at Project level: this means a user can be granted Project-specific rights without being given full access to all Projects, allowing for more targeted and controlled access. Read our dedicated documentation to learn more about IAM features.

Concepts

Refer to our dedicated concepts page to find definitions of the different terms referring to My Account.

Requirements: To perform the following steps, you must first ensure that:

1. Configure your environment variables.

Note: This is an optional step that seeks to simplify your usage of the APIs.

2. Edit the POST request payload you will use to create your Project.

Replace the parameters in the following example:

ParameterDescription
nameName of the Project you want to create.
organization_idYour Organization ID. It must be in UUID format.
descriptionDescription for the Project you want to create.

3. Run the following command to create a Project.

Make sure you include the payload you edited in the previous step.

You should get a response like the following: Note: This is a response example, the UUIDs displayed are not real.

4. Run the following command to list your Projects.

You should get a response like the following:

5. Run the following command to update your Projects. Note: Do not forget to replace the Project's ID with your own. You can retrieve it from the "List Project" response above

On the Scaleway Console, the Account scope covers account and Organization creation as well as personal data configuration and management of Projects. Currently, the public Account API only allows you to manage Projects.

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

Projects act as isolated groupings of Scaleway resources. Every Scaleway Organization has a default Project, and you can create new Projects if necessary.

List all Projects of an Organization

List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project.

GET
/account/v2/projects
Query Parameters

organization_id
string
Organization ID of the Project. (UUID format).

name
string
Name of the Project.

page
integer
Page number for the returned Projects. The default value is 1.

page_size
integer
Maximum number of Project per page. The default value is 20.

order_by
string
Sort order of the returned Projects. Possible values are created_at_asc, created_at_desc, name_asc and name_desc. The default value is created_at_asc.

project_ids
array
Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
200 Response

total_count
integer
Total number of Projects.

projects
array
Paginated returned Projects.
Response Example

Generate a new Project for an Organization, specifying its configuration including name and description.

POST
/account/v2/projects
Body

name
string
Name of the Project.

organization_id
string
Organization ID of the Project. (UUID format).

description
nullable string
Description of the Project.
Request Example
200 Response

id
string
ID of the Project. (UUID format).

name
string
Name of the Project.

organization_id
string
Organization ID of the Project. (UUID format).

created_at
nullable string
Creation date of the Project. (RFC 3339 format).

updated_at
nullable string
Update date of the Project. (RFC 3339 format).

description
string
Description of the Project.
Response Example

Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.

GET
/account/v2/projects/{project_id}
Path Parameters

project_id
required string
Project ID of the Project. (UUID format).
200 Response

id
string
ID of the Project. (UUID format).

name
string
Name of the Project.

organization_id
string
Organization ID of the Project. (UUID format).

created_at
nullable string
Creation date of the Project. (RFC 3339 format).

updated_at
nullable string
Update date of the Project. (RFC 3339 format).

description
string
Description of the Project.
Response Example

Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.

PATCH
/account/v2/projects/{project_id}
Path Parameters

project_id
required string
Project ID of the Project. (UUID format).
Body

name
nullable string
Name of the Project.

description
nullable string
Description of the Project.
Request Example
200 Response

id
string
ID of the Project. (UUID format).

name
string
Name of the Project.

organization_id
string
Organization ID of the Project. (UUID format).

created_at
nullable string
Creation date of the Project. (RFC 3339 format).

updated_at
nullable string
Update date of the Project. (RFC 3339 format).

description
string
Description of the Project.
Response Example

Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.

DELETE
/account/v2/projects/{project_id}
Path Parameters

project_id
required string
Project ID of the Project. (UUID format).
204 Response

Empty response