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 includes the creation and update date of the Project.
query Parameters
organization_idOrganization ID of the Project.
nameName of the Project.
pagePage number for the returned Projects.
page_sizeMaximum number of Project per page.
order_bySort order of the returned Projects.
project_idsProject IDs to filter for. The results will be limited to any Projects with an ID in this array.
List all Projects of an Organization › Responses
total_countTotal number of Projects.
Paginated returned Projects.
Create a new Project for an Organization
Generate a new Project for an Organization, specifying its configuration including name and description.
Create a new Project for an Organization › Request Body
nameName of the Project.
organization_idOrganization ID of the Project.
descriptionDescription of the Project.
Create a new Project for an Organization › Responses
idID of the Project. (UUID format)
nameName of the Project.
organization_idOrganization ID of the Project. (UUID format)
created_atCreation date of the Project. (RFC 3339 format)
updated_atUpdate date of the Project. (RFC 3339 format)
descriptionDescription of the Project.
Qualification of the Project.
Get an existing Project
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.
path Parameters
project_idProject ID of the Project.
Get an existing Project › Responses
idID of the Project. (UUID format)
nameName of the Project.
organization_idOrganization ID of the Project. (UUID format)
created_atCreation date of the Project. (RFC 3339 format)
updated_atUpdate date of the Project. (RFC 3339 format)
descriptionDescription of the Project.
Qualification of the Project.
Delete an existing Project
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.
path Parameters
project_idProject ID of the Project.
Delete an existing Project › Responses
Update Project
Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
path Parameters
project_idProject ID of the Project.
Update Project › Request Body
nameName of the Project.
descriptionDescription of the Project.
Update Project › Responses
idID of the Project. (UUID format)
nameName of the Project.
organization_idOrganization ID of the Project. (UUID format)
created_atCreation date of the Project. (RFC 3339 format)
updated_atUpdate date of the Project. (RFC 3339 format)
descriptionDescription of the Project.
Qualification of the Project.