Skip to content
Merged
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
8 changes: 0 additions & 8 deletions docs/commands/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@
# Documentation for `scw account`
This API allows you to manage your Scaleway Projects.

- [Project management commands](#project-management-commands)
- [Create a new Project for an Organization](#create-a-new-project-for-an-organization)
- [Delete an existing Project](#delete-an-existing-project)
- [Get an existing Project](#get-an-existing-project)
- [List all Projects of an Organization](#list-all-projects-of-an-organization)
- [Update Project](#update-project)


## Project management commands

Project management commands.
Expand Down
5 changes: 0 additions & 5 deletions docs/commands/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,6 @@ aliases in your commands are evaluated and you get completion
"scw <TAB>" will complete "isl"


- [Create a new alias for a command](#create-a-new-alias-for-a-command)
- [Delete an alias](#delete-an-alias)
- [List aliases and their commands](#list-aliases-and-their-commands)


## Create a new alias for a command

This command help you create aliases and save it to your config
Expand Down
29 changes: 0 additions & 29 deletions docs/commands/apple-silicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,6 @@
# Documentation for `scw apple-silicon`
Apple silicon API.

- [OS management commands](#os-management-commands)
- [Get an Operating System (OS)](#get-an-operating-system-(os))
- [List all Operating Systems (OS)](#list-all-operating-systems-(os))
- [Private network management command](#private-network-management-command)
- [Add a server to a Private Network](#add-a-server-to-a-private-network)
- [Delete a Private Network](#delete-a-private-network)
- [List the Private Networks of a server](#list-the-private-networks-of-a-server)
- [Set multiple Private Networks on a server](#set-multiple-private-networks-on-a-server)
- [Runner management commands](#runner-management-commands)
- [Create a new runner configuration](#create-a-new-runner-configuration)
- [Create a new runner configuration](#create-a-new-runner-configuration)
- [Retrieve a runner configuration](#retrieve-a-runner-configuration)
- [List runner configurations associated with a server](#list-runner-configurations-associated-with-a-server)
- [Create a new runner configuration](#create-a-new-runner-configuration)
- [Apple silicon management commands](#apple-silicon-management-commands)
- [Create a server](#create-a-server)
- [Delete a server](#delete-a-server)
- [Get a server](#get-a-server)
- [List all servers](#list-all-servers)
- [Reboot a server](#reboot-a-server)
- [Reinstall a server](#reinstall-a-server)
- [SSH into a server](#ssh-into-a-server)
- [Update a server](#update-a-server)
- [Wait for a server to reach a stable state](#wait-for-a-server-to-reach-a-stable-state)
- [Server-Types management commands](#server-types-management-commands)
- [Get a server type](#get-a-server-type)
- [List server types](#list-server-types)


## OS management commands

OS management commands.
Expand Down
6 changes: 0 additions & 6 deletions docs/commands/audit-trail.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@
# Documentation for `scw audit-trail`
This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.

- [Represent an entry in the Audit Trail](#represent-an-entry-in-the-audit-trail)
- [List events](#list-events)
- [Product integrated with Audit Trail](#product-integrated-with-audit-trail)
- [Retrieve the list of Scaleway resources for which you have Audit Trail events](#retrieve-the-list-of-scaleway-resources-for-which-you-have-audit-trail-events)


## Represent an entry in the Audit Trail

Represent an entry in the Audit Trail.
Expand Down
4 changes: 0 additions & 4 deletions docs/commands/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
# Documentation for `scw autocomplete`
Autocomplete related commands

- [Install autocomplete script](#install-autocomplete-script)
- [Show autocomplete script for current shell](#show-autocomplete-script-for-current-shell)


## Install autocomplete script

Install autocomplete script for a given shell and OS.
Expand Down
42 changes: 0 additions & 42 deletions docs/commands/baremetal.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,6 @@
# Documentation for `scw baremetal`
Elastic Metal - Private Networks API.

- [Baseboard Management Controller (BMC) management commands](#baseboard-management-controller-(bmc)-management-commands)
- [Get BMC access](#get-bmc-access)
- [Start BMC access](#start-bmc-access)
- [Stop BMC access](#stop-bmc-access)
- [Server offer management commands](#server-offer-management-commands)
- [Get offer](#get-offer)
- [List offers](#list-offers)
- [Server options management commands](#server-options-management-commands)
- [Add server option](#add-server-option)
- [Delete server option](#delete-server-option)
- [Get option](#get-option)
- [List options](#list-options)
- [Operating System (OS) management commands](#operating-system-(os)-management-commands)
- [Get OS with an ID](#get-os-with-an-id)
- [List available OSes](#list-available-oses)
- [Partitioning-schemas management commands](#partitioning-schemas-management-commands)
- [Private network management command](#private-network-management-command)
- [Add a server to a Private Network](#add-a-server-to-a-private-network)
- [Delete a Private Network](#delete-a-private-network)
- [List the Private Networks of a server](#list-the-private-networks-of-a-server)
- [Set multiple Private Networks on a server](#set-multiple-private-networks-on-a-server)
- [Server management commands](#server-management-commands)
- [Attach a new flexible IP to a server](#attach-a-new-flexible-ip-to-a-server)
- [Create multiple Elastic Metal servers](#create-multiple-elastic-metal-servers)
- [Create an Elastic Metal server](#create-an-elastic-metal-server)
- [Delete an Elastic Metal server](#delete-an-elastic-metal-server)
- [Get a specific Elastic Metal server](#get-a-specific-elastic-metal-server)
- [Return server metrics](#return-server-metrics)
- [Install an Elastic Metal server](#install-an-elastic-metal-server)
- [List Elastic Metal servers for an Organization](#list-elastic-metal-servers-for-an-organization)
- [List server events](#list-server-events)
- [Reboot an Elastic Metal server](#reboot-an-elastic-metal-server)
- [Start an Elastic Metal server](#start-an-elastic-metal-server)
- [Stop an Elastic Metal server](#stop-an-elastic-metal-server)
- [Update an Elastic Metal server](#update-an-elastic-metal-server)
- [Update IP](#update-ip)
- [Wait for a server to reach a stable state (delivery and installation)](#wait-for-a-server-to-reach-a-stable-state-(delivery-and-installation))
- [Settings management commands](#settings-management-commands)
- [List all settings](#list-all-settings)
- [Update setting](#update-setting)


## Baseboard Management Controller (BMC) management commands

A Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
Expand Down
28 changes: 0 additions & 28 deletions docs/commands/billing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,6 @@
# Documentation for `scw billing`
This API allows you to query billing related objects.

- [Budget management commands](#budget-management-commands)
- [Create a new budget.](#create-a-new-budget.)
- [Delete a budget.](#delete-a-budget.)
- [Fetch a budget.](#fetch-a-budget.)
- [List your budgets, filtering by `organization_id`.](#list-your-budgets,-filtering-by-`organization_id`.)
- [Update a budget.](#update-a-budget.)
- [Budget alerts management commands](#budget-alerts-management-commands)
- [Create a new budget alert.](#create-a-new-budget-alert.)
- [Delete a budget alert.](#delete-a-budget-alert.)
- [Update a budget alert.](#update-a-budget-alert.)
- [Budget alert notification management commands](#budget-alert-notification-management-commands)
- [Create a new budget alert notification.](#create-a-new-budget-alert-notification.)
- [Delete a budget alert notification.](#delete-a-budget-alert-notification.)
- [Update a budget alert notification.](#update-a-budget-alert-notification.)
- [](#)
- [List charges](#list-charges)
- [Consumption management commands](#consumption-management-commands)
- [Get monthly consumption](#get-monthly-consumption)
- [Get monthly consumption taxes](#get-monthly-consumption-taxes)
- [Discount management commands](#discount-management-commands)
- [List discounts](#list-discounts)
- [Invoice management commands](#invoice-management-commands)
- [Download an invoice](#download-an-invoice)
- [Export invoices](#export-invoices)
- [Get an invoice](#get-an-invoice)
- [List invoices](#list-invoices)


## Budget management commands

Budget management commands.
Expand Down
20 changes: 0 additions & 20 deletions docs/commands/block.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,6 @@
# Documentation for `scw block`
This API allows you to manage your Block Storage volumes.

- [A Block Storage snapshot is a read-only picture of a Block volume, taken at a specific time](#a-block-storage-snapshot-is-a-read-only-picture-of-a-block-volume,-taken-at-a-specific-time)
- [Create a snapshot of a volume](#create-a-snapshot-of-a-volume)
- [Delete a snapshot](#delete-a-snapshot)
- [Export a snapshot to a Scaleway Object Storage bucket](#export-a-snapshot-to-a-scaleway-object-storage-bucket)
- [Get a snapshot](#get-a-snapshot)
- [Import a snapshot from a Scaleway Object Storage bucket](#import-a-snapshot-from-a-scaleway-object-storage-bucket)
- [List all snapshots](#list-all-snapshots)
- [Update a snapshot](#update-a-snapshot)
- [Wait for snapshot to reach a stable state](#wait-for-snapshot-to-reach-a-stable-state)
- [A Block Storage volume is a logical storage drive on a network-connected storage system. It is exposed to Instances as if it were a physical disk, and can be attached and detached like a hard drive. Several Block volumes can be attached to one Instance at a time](#a-block-storage-volume-is-a-logical-storage-drive-on-a-network-connected-storage-system.-it-is-exposed-to-instances-as-if-it-were-a-physical-disk,-and-can-be-attached-and-detached-like-a-hard-drive.-several-block-volumes-can-be-attached-to-one-instance-at-a-time)
- [Create a volume](#create-a-volume)
- [Delete a detached volume](#delete-a-detached-volume)
- [Get a volume](#get-a-volume)
- [List volumes](#list-volumes)
- [Update a volume](#update-a-volume)
- [Wait for volume to reach a stable state](#wait-for-volume-to-reach-a-stable-state)
- [Block Storage volume types are determined by their storage class and their IOPS. There are two storage classes available: `bssd` and `sbs`. The IOPS can be chosen for volumes of the `sbs` storage class](#block-storage-volume-types-are-determined-by-their-storage-class-and-their-iops.-there-are-two-storage-classes-available:-`bssd`-and-`sbs`.-the-iops-can-be-chosen-for-volumes-of-the-`sbs`-storage-class)
- [List volume types](#list-volume-types)


## A Block Storage snapshot is a read-only picture of a Block volume, taken at a specific time

You can then revert your data to the previous snapshot. You can also create a new read/write Block volume from a previous snapshot.
Expand Down
43 changes: 0 additions & 43 deletions docs/commands/cockpit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,49 +2,6 @@
# Documentation for `scw cockpit`
This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs.

- [Alerting management commands](#alerting-management-commands)
- [Disable the Alert manager](#disable-the-alert-manager)
- [Enable the Alert manager](#enable-the-alert-manager)
- [Get the Alert manager](#get-the-alert-manager)
- [Config management commands](#config-management-commands)
- [Generate a data source configuration snippet](#generate-a-data-source-configuration-snippet)
- [Contact point management commands](#contact-point-management-commands)
- [Create a contact point](#create-a-contact-point)
- [Delete a contact point](#delete-a-contact-point)
- [List contact points](#list-contact-points)
- [Datasource management commands](#datasource-management-commands)
- [Create a data source](#create-a-data-source)
- [Delete a data source](#delete-a-data-source)
- [Get a data source](#get-a-data-source)
- [List data sources](#list-data-sources)
- [Update a data source](#update-a-data-source)
- [Grafana user management commands](#grafana-user-management-commands)
- [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)
- [(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)
- [List plan types](#list-plan-types)
- [Apply a pricing plan](#apply-a-pricing-plan)
- [Product dashboards management commands](#product-dashboards-management-commands)
- [Get Scaleway resource dashboard](#get-scaleway-resource-dashboard)
- [List Scaleway resources dashboards](#list-scaleway-resources-dashboards)
- [Test alert management commands](#test-alert-management-commands)
- [Trigger a test alert](#trigger-a-test-alert)
- [Token management commands](#token-management-commands)
- [Create a token](#create-a-token)
- [Delete a token](#delete-a-token)
- [Get a token](#get-a-token)
- [List tokens](#list-tokens)
- [Usage overview management commands](#usage-overview-management-commands)
- [Get data source usage overview](#get-data-source-usage-overview)


## Alerting management commands

Alerting management commands.
Expand Down
16 changes: 0 additions & 16 deletions docs/commands/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,6 @@ The following environment variables are supported:

Read more about the config management engine at https://github.com/scaleway/scaleway-sdk-go/tree/master/scw#scaleway-config

- [Destroy the config file](#destroy-the-config-file)
- [Dump the config file](#dump-the-config-file)
- [Edit the configuration file](#edit-the-configuration-file)
- [Get a value from the config file](#get-a-value-from-the-config-file)
- [Import configurations from another file](#import-configurations-from-another-file)
- [Get config values from the config file for the current profile](#get-config-values-from-the-config-file-for-the-current-profile)
- [Allows the activation and deletion of a profile from the config file](#allows-the-activation-and-deletion-of-a-profile-from-the-config-file)
- [Mark a profile as active in the config file](#mark-a-profile-as-active-in-the-config-file)
- [Delete a profile from the config file](#delete-a-profile-from-the-config-file)
- [List all profiles in the config file](#list-all-profiles-in-the-config-file)
- [Reset the config](#reset-the-config)
- [Set a line from the config file](#set-a-line-from-the-config-file)
- [Unset a line from the config file](#unset-a-line-from-the-config-file)
- [Validate the config](#validate-the-config)


## Destroy the config file


Expand Down
33 changes: 0 additions & 33 deletions docs/commands/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,6 @@
# Documentation for `scw container`
This API allows you to manage your Serverless Containers.

- [Container management commands](#container-management-commands)
- [Create a new container in a namespace.](#create-a-new-container-in-a-namespace.)
- [Delete the container associated with the specified ID.](#delete-the-container-associated-with-the-specified-id.)
- [Get the container associated with the specified ID.](#get-the-container-associated-with-the-specified-id.)
- [List all containers the caller can access (read permission).](#list-all-containers-the-caller-can-access-(read-permission).)
- [Redeploy a container](#redeploy-a-container)
- [Update the container associated with the specified ID.](#update-the-container-associated-with-the-specified-id.)
- [Deploy a container](#deploy-a-container)
- [Domain management commands](#domain-management-commands)
- [Create a new custom domain for the container with the specified ID.](#create-a-new-custom-domain-for-the-container-with-the-specified-id.)
- [Delete the custom domain associated with the specified ID.](#delete-the-custom-domain-associated-with-the-specified-id.)
- [Get the custom domain associated with the specified ID.](#get-the-custom-domain-associated-with-the-specified-id.)
- [List all custom domains the caller can access (read permission).](#list-all-custom-domains-the-caller-can-access-(read-permission).)
- [Update the domain associated with the specified ID.](#update-the-domain-associated-with-the-specified-id.)
- [Namespace management commands](#namespace-management-commands)
- [Create a new namespace.](#create-a-new-namespace.)
- [Delete the namespace associated with the specified ID.](#delete-the-namespace-associated-with-the-specified-id.)
- [Get the namespace associated with the specified ID.](#get-the-namespace-associated-with-the-specified-id.)
- [List all namespaces the caller can access (read permission).](#list-all-namespaces-the-caller-can-access-(read-permission).)
- [Update the namespace associated with the specified ID.](#update-the-namespace-associated-with-the-specified-id.)
- [Token management commands](#token-management-commands)
- [Create a new revocable token](#create-a-new-revocable-token)
- [Delete a token](#delete-a-token)
- [Get a token](#get-a-token)
- [List all tokens](#list-all-tokens)
- [Trigger management commands](#trigger-management-commands)
- [Create a new trigger for the container with the specified ID.](#create-a-new-trigger-for-the-container-with-the-specified-id.)
- [Delete the trigger associated with the specified ID.](#delete-the-trigger-associated-with-the-specified-id.)
- [Get the trigger associated with the specified ID.](#get-the-trigger-associated-with-the-specified-id.)
- [List all triggers the caller can access (read permission).](#list-all-triggers-the-caller-can-access-(read-permission).)
- [Update the trigger associated with the specified ID.](#update-the-trigger-associated-with-the-specified-id.)


## Container management commands

Container management commands.
Expand Down
14 changes: 0 additions & 14 deletions docs/commands/datalab.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,6 @@
# Documentation for `scw datalab`
Clusters for Apache Spark™ API.

- [](#)
- [List datalab resources](#list-datalab-resources)
- [](#)
- [Create datalab resources](#create-datalab-resources)
- [Delete datalab resources](#delete-datalab-resources)
- [Get datalab resources](#get-datalab-resources)
- [List datalab resources](#list-datalab-resources)
- [Update datalab resources](#update-datalab-resources)
- [](#)
- [List datalab resources](#list-datalab-resources)
- [](#)
- [List datalab resources](#list-datalab-resources)


##

Lists the Apache Spark™ versions available for cluster creation.
Expand Down
25 changes: 0 additions & 25 deletions docs/commands/datawarehouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,6 @@
# Documentation for `scw datawarehouse`
Data Warehouse API.

- [Database management commands](#database-management-commands)
- [Create a new database within a deployment](#create-a-new-database-within-a-deployment)
- [Delete a database from a deployment](#delete-a-database-from-a-deployment)
- [List databases within a deployment](#list-databases-within-a-deployment)
- [Deployment management commands](#deployment-management-commands)
- [Create a deployment](#create-a-deployment)
- [Delete a deployment](#delete-a-deployment)
- [Get a deployment](#get-a-deployment)
- [Get deployment TLS certificate](#get-deployment-tls-certificate)
- [List deployments](#list-deployments)
- [Update a deployment](#update-a-deployment)
- [Endpoint management commands](#endpoint-management-commands)
- [Create a new endpoint for a deployment](#create-a-new-endpoint-for-a-deployment)
- [Delete an endpoint from a deployment](#delete-an-endpoint-from-a-deployment)
- [List available presets](#list-available-presets)
- [List available presets](#list-available-presets)
- [User management commands](#user-management-commands)
- [Create a new user for a deployment](#create-a-new-user-for-a-deployment)
- [Delete a user from a deployment](#delete-a-user-from-a-deployment)
- [List users associated with a deployment](#list-users-associated-with-a-deployment)
- [Update an existing user for a deployment](#update-an-existing-user-for-a-deployment)
- [List available Clickhouse® versions](#list-available-clickhouse®-versions)
- [List available ClickHouse® versions](#list-available-clickhouse®-versions)


## Database management commands

Manage databases within a deployment.
Expand Down
Loading
Loading