Account APIv2

Download OpenAPI

Introduction

The Account API allows you to manage projects. Project is Scaleway’s resource management feature. Designed to help you organize your infrastructure and cloud services, the feature allows resources to be isolated and grouped into specific projects.

List projects

GET
/account/v2/projects
Query Parameters

organization_id
string
The organization ID of the project (UUID format).

name
nullable string
The name of the project.

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

page_size
integer
The maximum number of project per page. The default value is 20.

order_by
string
The 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
Filter out by a list of project ID.
200 Response

total_count
integer
The total number of projects.

projects
array
The paginated returned projects.
Response Example
POST
/account/v2/projects
Body

name
string
The name of the project.

organization_id
string
The organization ID of the project (UUID format).

description
nullable string
The description of the project.
Request Example
200 Response

id
string
The ID of the project (UUID format).

name
string
The name of the project.

organization_id
string
The organization ID of the project (UUID format).

created_at
nullable string
The creation date of the project (RFC 3339 format).

updated_at
nullable string
The update date of the project (RFC 3339 format).

description
string
The description of the project.
Response Example
GET
/account/v2/projects/{project_id}
Path Parameters

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

id
string
The ID of the project (UUID format).

name
string
The name of the project.

organization_id
string
The organization ID of the project (UUID format).

created_at
nullable string
The creation date of the project (RFC 3339 format).

updated_at
nullable string
The update date of the project (RFC 3339 format).

description
string
The description of the project.
Response Example
PATCH
/account/v2/projects/{project_id}
Path Parameters

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

name
nullable string
The name of the project.

description
nullable string
The description of the project.
Request Example
200 Response

id
string
The ID of the project (UUID format).

name
string
The name of the project.

organization_id
string
The organization ID of the project (UUID format).

created_at
nullable string
The creation date of the project (RFC 3339 format).

updated_at
nullable string
The update date of the project (RFC 3339 format).

description
string
The description of the project.
Response Example
DELETE
/account/v2/projects/{project_id}
Path Parameters

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

Empty response