Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@ USAGE:
scw apple-silicon server create [arg=value ...]

ARGS:
[name=<generated>] Create a server with this given name
[project-id] Project ID to use. If none is passed the default project ID will be used
[type] Create a server of the given type
[os-id] Create a server with the given os_id
[enable-vpc] Activate the Private Network feature for this server
[commitment-type] Activate commitment for this server (duration_24h | renewed_monthly | none)
[public-bandwidth-bps] Public bandwidth to configure for this server. Expressed in bits per second.
[runner-configuration.name]
[runner-configuration.url]
[runner-configuration.token]
[runner-configuration.provider] (unknown_provider | github | gitlab)
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3)
[name=<generated>] Create a server with this given name
[project-id] Project ID to use. If none is passed the default project ID will be used
[type] Create a server of the given type
[os-id] Create a server with the given os_id
[enable-vpc] Activate the Private Network feature for this server
[commitment-type] Activate commitment for this server (duration_24h | renewed_monthly | none)
[public-bandwidth-bps] Public bandwidth to configure for this server. Expressed in bits per second.
[runner-configuration.name]
[runner-configuration.url]
[runner-configuration.token]
[runner-configuration.provider] (unknown_provider | github | gitlab)
[applied-runner-configurations.runner-configuration-ids.{index}]
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3)

FLAGS:
-h, --help help for create
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ USAGE:
scw apple-silicon server update <server-id ...> [arg=value ...]

ARGS:
server-id UUID of the server you want to update
[name] Updated name for your server
[schedule-deletion] Specify whether the server should be flagged for automatic deletion
[enable-vpc] Activate or deactivate Private Network support for this server
[commitment-type.commitment-type] (duration_24h | renewed_monthly | none)
[public-bandwidth-bps] Public bandwidth configured for this server
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3)
server-id UUID of the server you want to update
[name] Updated name for your server
[schedule-deletion] Specify whether the server should be flagged for automatic deletion
[enable-vpc] Activate or deactivate Private Network support for this server
[commitment-type.commitment-type] (duration_24h | renewed_monthly | none)
[public-bandwidth-bps] Public bandwidth configured for this server
[applied-runner-configurations.runner-configuration-ids.{index}]
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3)

FLAGS:
-h, --help help for update
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
[project-id] (Optional) ID of the Project containing the Audit Trail events
[resource-type] (Optional) Type of the Scaleway resource (unknown_type | secm_secret | secm_secret_version | kube_cluster | kube_pool | kube_node | kube_acl | keym_key | iam_user | iam_application | iam_group | iam_policy | iam_api_key | iam_ssh_key | iam_rule | iam_saml | iam_saml_certificate | secret_manager_secret | secret_manager_version | key_manager_key | account_user | account_organization | account_project | instance_server | instance_placement_group | instance_security_group | instance_volume | instance_snapshot | instance_image | apple_silicon_server | baremetal_server | baremetal_setting | ipam_ip | sbs_volume | sbs_snapshot | load_balancer_lb | load_balancer_ip | load_balancer_frontend | load_balancer_backend | load_balancer_route | load_balancer_acl | load_balancer_certificate | sfs_filesystem | vpc_private_network | edge_services_plan | edge_services_pipeline | edge_services_dns_stage | edge_services_tls_stage | edge_services_cache_stage | edge_services_route_stage | edge_services_route_rules | edge_services_waf_stage | edge_services_backend_stage)
[resource-type] (Optional) Type of the Scaleway resource (unknown_type | secm_secret | secm_secret_version | kube_cluster | kube_pool | kube_node | kube_acl | keym_key | iam_user | iam_application | iam_group | iam_policy | iam_api_key | iam_ssh_key | iam_rule | iam_saml | iam_saml_certificate | iam_scim | iam_scim_token | secret_manager_secret | secret_manager_version | key_manager_key | account_user | account_organization | account_project | instance_server | instance_placement_group | instance_security_group | instance_volume | instance_snapshot | instance_image | apple_silicon_server | baremetal_server | baremetal_setting | ipam_ip | sbs_volume | sbs_snapshot | load_balancer_lb | load_balancer_ip | load_balancer_frontend | load_balancer_backend | load_balancer_route | load_balancer_acl | load_balancer_certificate | sfs_filesystem | vpc_private_network | edge_services_plan | edge_services_pipeline | edge_services_dns_stage | edge_services_tls_stage | edge_services_cache_stage | edge_services_route_stage | edge_services_route_rules | edge_services_waf_stage | edge_services_backend_stage)
[method-name] (Optional) Name of the method of the API call performed
[status] (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied
[recorded-after] (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a Grafana user
Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it.
Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a Grafana user
Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.

USAGE:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List Grafana users
List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.

USAGE:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Reset a Grafana user password
Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
A new password regenerates and only displays once. Make sure that you save it.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ USAGE:
scw cockpit grafana-user <command>

AVAILABLE COMMANDS:
create Create a Grafana user
delete Delete a Grafana user
list List Grafana users
reset-password Reset a Grafana user password
create (Deprecated) EOL 2026-01-20
delete (Deprecated) EOL 2026-01-20
list (Deprecated) EOL 2026-01-20
reset-password (Deprecated) EOL 2026-01-20

FLAGS:
-h, --help help for grafana-user
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve a pricing plan for the given Project, specified by the ID of the Project.
Deprecated: retention is now managed at the data source level.
Deprecated due to retention now being managed at the data source level.

USAGE:
scw cockpit plan get [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve a list of available pricing plan types.
Deprecated: retention is now managed at the data source level.
Deprecated due to retention now being managed at the data source level.

USAGE:
scw cockpit plan list [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
Deprecated: retention is now managed at the data source level.
Deprecated due to retention now being managed at the data source level.

USAGE:
scw cockpit plan select [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve the Topics and Events information of the specified Project ID. Information include the activation status and the Topics and Events API endpoint URL.
Retrieve the Topics and Events information of the specified Project ID. information include the activation status and the Topics and Events API endpoint URL.

USAGE:
scw mnq sns get-info [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrieve the Queues information of the specified Project ID. Information include the activation status and the Queues API endpoint URL.
Retrieve the Queues information of the specified Project ID. information include the activation status and the Queues API endpoint URL.

USAGE:
scw mnq sqs get-info [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters.
You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain.

USAGE:
scw tem email create [arg=value ...]
Expand Down
2 changes: 2 additions & 0 deletions docs/commands/apple-silicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ scw apple-silicon server create [arg=value ...]
| runner-configuration.url | | |
| runner-configuration.token | | |
| runner-configuration.provider | One of: `unknown_provider`, `github`, `gitlab` | |
| applied-runner-configurations.runner-configuration-ids.{index} | | |
| zone | Default: `fr-par-1`<br />One of: `fr-par-3` | Zone to target. If none is passed will use default zone from the config |


Expand Down Expand Up @@ -352,6 +353,7 @@ scw apple-silicon server update <server-id ...> [arg=value ...]
| enable-vpc | | Activate or deactivate Private Network support for this server |
| commitment-type.commitment-type | One of: `duration_24h`, `renewed_monthly`, `none` | |
| public-bandwidth-bps | | Public bandwidth configured for this server |
| applied-runner-configurations.runner-configuration-ids.{index} | | |
| zone | Default: `fr-par-1`<br />One of: `fr-par-3` | Zone to target. If none is passed will use default zone from the config |


Expand Down
2 changes: 1 addition & 1 deletion docs/commands/audit-trail.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ scw audit-trail event list [arg=value ...]
| Name | | Description |
|------|---|-------------|
| project-id | | (Optional) ID of the Project containing the Audit Trail events |
| resource-type | One of: `unknown_type`, `secm_secret`, `secm_secret_version`, `kube_cluster`, `kube_pool`, `kube_node`, `kube_acl`, `keym_key`, `iam_user`, `iam_application`, `iam_group`, `iam_policy`, `iam_api_key`, `iam_ssh_key`, `iam_rule`, `iam_saml`, `iam_saml_certificate`, `secret_manager_secret`, `secret_manager_version`, `key_manager_key`, `account_user`, `account_organization`, `account_project`, `instance_server`, `instance_placement_group`, `instance_security_group`, `instance_volume`, `instance_snapshot`, `instance_image`, `apple_silicon_server`, `baremetal_server`, `baremetal_setting`, `ipam_ip`, `sbs_volume`, `sbs_snapshot`, `load_balancer_lb`, `load_balancer_ip`, `load_balancer_frontend`, `load_balancer_backend`, `load_balancer_route`, `load_balancer_acl`, `load_balancer_certificate`, `sfs_filesystem`, `vpc_private_network`, `edge_services_plan`, `edge_services_pipeline`, `edge_services_dns_stage`, `edge_services_tls_stage`, `edge_services_cache_stage`, `edge_services_route_stage`, `edge_services_route_rules`, `edge_services_waf_stage`, `edge_services_backend_stage` | (Optional) Type of the Scaleway resource |
| resource-type | One of: `unknown_type`, `secm_secret`, `secm_secret_version`, `kube_cluster`, `kube_pool`, `kube_node`, `kube_acl`, `keym_key`, `iam_user`, `iam_application`, `iam_group`, `iam_policy`, `iam_api_key`, `iam_ssh_key`, `iam_rule`, `iam_saml`, `iam_saml_certificate`, `iam_scim`, `iam_scim_token`, `secret_manager_secret`, `secret_manager_version`, `key_manager_key`, `account_user`, `account_organization`, `account_project`, `instance_server`, `instance_placement_group`, `instance_security_group`, `instance_volume`, `instance_snapshot`, `instance_image`, `apple_silicon_server`, `baremetal_server`, `baremetal_setting`, `ipam_ip`, `sbs_volume`, `sbs_snapshot`, `load_balancer_lb`, `load_balancer_ip`, `load_balancer_frontend`, `load_balancer_backend`, `load_balancer_route`, `load_balancer_acl`, `load_balancer_certificate`, `sfs_filesystem`, `vpc_private_network`, `edge_services_plan`, `edge_services_pipeline`, `edge_services_dns_stage`, `edge_services_tls_stage`, `edge_services_cache_stage`, `edge_services_route_stage`, `edge_services_route_rules`, `edge_services_waf_stage`, `edge_services_backend_stage` | (Optional) Type of the Scaleway resource |
| method-name | | (Optional) Name of the method of the API call performed |
| status | | (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied |
| recorded-after | | (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default |
Expand Down
26 changes: 15 additions & 11 deletions docs/commands/cockpit.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ This API allows you to manage your Scaleway Cockpit, for storing and visualizing
- [Get your Cockpit's Grafana](#get-your-cockpit's-grafana)
- [Synchronize Grafana data sources](#synchronize-grafana-data-sources)
- [Grafana user management commands](#grafana-user-management-commands)
- [Create a Grafana user](#create-a-grafana-user)
- [Delete a Grafana user](#delete-a-grafana-user)
- [List Grafana users](#list-grafana-users)
- [Reset a Grafana user password](#reset-a-grafana-user-password)
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
- [Managed alerts management commands](#managed-alerts-management-commands)
- [Pricing plans management commands](#pricing-plans-management-commands)
- [Get current plan](#get-current-plan)
Expand Down Expand Up @@ -342,8 +342,9 @@ scw cockpit grafana sync-data-sources [arg=value ...]
Grafana user management commands.


### Create a Grafana user
### (Deprecated) EOL 2026-01-20

Create a Grafana user
Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it.
Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation.

Expand All @@ -364,8 +365,9 @@ scw cockpit grafana-user create [arg=value ...]



### Delete a Grafana user
### (Deprecated) EOL 2026-01-20

Delete a Grafana user
Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.

**Usage:**
Expand All @@ -384,8 +386,9 @@ scw cockpit grafana-user delete [arg=value ...]



### List Grafana users
### (Deprecated) EOL 2026-01-20

List Grafana users
List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.

**Usage:**
Expand All @@ -404,8 +407,9 @@ scw cockpit grafana-user list [arg=value ...]



### Reset a Grafana user password
### (Deprecated) EOL 2026-01-20

Reset a Grafana user password
Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
A new password regenerates and only displays once. Make sure that you save it.

Expand Down Expand Up @@ -447,7 +451,7 @@ Pricing plans management commands.
### Get current plan

Retrieve a pricing plan for the given Project, specified by the ID of the Project.
Deprecated: retention is now managed at the data source level.
Deprecated due to retention now being managed at the data source level.

**Usage:**

Expand All @@ -467,7 +471,7 @@ scw cockpit plan get [arg=value ...]
### List plan types

Retrieve a list of available pricing plan types.
Deprecated: retention is now managed at the data source level.
Deprecated due to retention now being managed at the data source level.

**Usage:**

Expand All @@ -487,7 +491,7 @@ scw cockpit plan list [arg=value ...]
### Apply a pricing plan

Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
Deprecated: retention is now managed at the data source level.
Deprecated due to retention now being managed at the data source level.

**Usage:**

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/mnq.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ scw mnq sns get-credentials <sns-credentials-id ...> [arg=value ...]

### Get Topics and Events info

Retrieve the Topics and Events information of the specified Project ID. Information include the activation status and the Topics and Events API endpoint URL.
Retrieve the Topics and Events information of the specified Project ID. information include the activation status and the Topics and Events API endpoint URL.

**Usage:**

Expand Down Expand Up @@ -543,7 +543,7 @@ scw mnq sqs get-credentials <sqs-credentials-id ...> [arg=value ...]

### Get Queues info

Retrieve the Queues information of the specified Project ID. Information include the activation status and the Queues API endpoint URL.
Retrieve the Queues information of the specified Project ID. information include the activation status and the Queues API endpoint URL.

**Usage:**

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/tem.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ scw tem email cancel <email-id ...> [arg=value ...]

### Send an email

You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters.
You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain.

**Usage:**

Expand Down
Loading
Loading