This API allows you to manage your Scaleway Projects.
Project management commands.
Generate a new Project for an Organization, specifying its configuration including name and description.
Usage:
scw account project create [arg=value ...]Arguments:
| Name | Description | Argument Specifications |
|---|---|---|
| name | Name of the Project | Default: <generated> |
| description | Description of the Project | |
| organization-id | Organization ID to use. If none is passed the default organization ID will be used |
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.
Usage:
scw account project delete [arg=value ...]Arguments:
| Name | Description | Argument Specifications |
|---|---|---|
| project-id | Project ID to use. If none is passed the default project ID will be used |
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.
Usage:
scw account project get [arg=value ...]Arguments:
| Name | Description | Argument Specifications |
|---|---|---|
| project-id | Project ID to use. If none is passed the default project ID will be used |
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.
Usage:
scw account project list [arg=value ...]Arguments:
| Name | Description | Argument Specifications |
|---|---|---|
| name | Name of the Project | |
| order-by | Sort order of the returned Projects | One of: created_at_asc, created_at_desc, name_asc, name_desc |
| project-ids.{index} | Project IDs to filter for. The results will be limited to any Projects with an ID in this array | |
| organization-id | Organization ID to use. If none is passed the default organization ID will be used |
List all resources across all zones and products. Results are grouped by locality and product. Errors are aggregated and not fail-fast.
Usage:
scw account project list-resources <project-id ...> [arg=value ...]Arguments:
| Name | Description | Argument Specifications |
|---|---|---|
| project-id | Filter by project ID. If none is passed the default project ID will be used | Default: `` |
| zones.{index} | Filter by zones (comma-separated, e.g. fr-par-1,nl-ams-1). If empty, all zones are queried | |
| products.{index} | Filter by products (comma-separated, e.g. apple-silicon-server,baremetal-server,block-snapshot,block-volume,cockpit-data-source,cockpit-token,container-namespace,file-filesystem,fip-ip,function-namespace,inference-deployment,instance-ip,instance-security-group,instance-server,instance-snapshot,instance-volume,ipam-ip,k8s-cluster,keymanager-key,lb-lb,mongodb-instance,mongodb-snapshot,object-bucket,rdb-instance,redis-cluster,registry-namespace,s2s-vpn-vpn-gateway,searchdb-deployment,secret-secret,vpc-gw-gateway,vpc-gw-ip,vpc-vpc,webhosting-hosting). If empty, all products are queried | One of: apple-silicon-server, baremetal-server, block-snapshot, block-volume, cockpit-data-source, cockpit-token, container-namespace, file-filesystem, fip-ip, function-namespace, inference-deployment, instance-ip, instance-security-group, instance-server, instance-snapshot, instance-volume, ipam-ip, k8s-cluster, keymanager-key, lb-lb, mongodb-instance, mongodb-snapshot, object-bucket, rdb-instance, redis-cluster, registry-namespace, s2s-vpn-vpn-gateway, searchdb-deployment, secret-secret, vpc-gw-gateway, vpc-gw-ip, vpc-vpc, webhosting-hosting |
Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
Usage:
scw account project update [arg=value ...]Arguments:
| Name | Description | Argument Specifications |
|---|---|---|
| project-id | Project ID to use. If none is passed the default project ID will be used | |
| name | Name of the Project | |
| description | Description of the Project |