diff --git a/docs/commands/account.md b/docs/commands/account.md index 415ea8cc92..4c3de75cd0 100644 --- a/docs/commands/account.md +++ b/docs/commands/account.md @@ -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. diff --git a/docs/commands/alias.md b/docs/commands/alias.md index 9b2fc4a161..4abcbad7cf 100644 --- a/docs/commands/alias.md +++ b/docs/commands/alias.md @@ -15,11 +15,6 @@ aliases in your commands are evaluated and you get completion "scw " 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 diff --git a/docs/commands/apple-silicon.md b/docs/commands/apple-silicon.md index 40b981e157..6cc7bb290e 100644 --- a/docs/commands/apple-silicon.md +++ b/docs/commands/apple-silicon.md @@ -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. diff --git a/docs/commands/audit-trail.md b/docs/commands/audit-trail.md index ea801cea17..93f35d6852 100644 --- a/docs/commands/audit-trail.md +++ b/docs/commands/audit-trail.md @@ -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. diff --git a/docs/commands/autocomplete.md b/docs/commands/autocomplete.md index c35bc5531a..1ab27f38f7 100644 --- a/docs/commands/autocomplete.md +++ b/docs/commands/autocomplete.md @@ -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. diff --git a/docs/commands/baremetal.md b/docs/commands/baremetal.md index 4d63f9b4ee..e8f77ed697 100644 --- a/docs/commands/baremetal.md +++ b/docs/commands/baremetal.md @@ -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. diff --git a/docs/commands/billing.md b/docs/commands/billing.md index 9ea04185a1..edf8ac048f 100644 --- a/docs/commands/billing.md +++ b/docs/commands/billing.md @@ -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. diff --git a/docs/commands/block.md b/docs/commands/block.md index 780ae2845d..9c931bb073 100644 --- a/docs/commands/block.md +++ b/docs/commands/block.md @@ -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. diff --git a/docs/commands/cockpit.md b/docs/commands/cockpit.md index 307e270e82..e83362aede 100644 --- a/docs/commands/cockpit.md +++ b/docs/commands/cockpit.md @@ -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. diff --git a/docs/commands/config.md b/docs/commands/config.md index a5c1662883..72f9e4a6c2 100644 --- a/docs/commands/config.md +++ b/docs/commands/config.md @@ -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 diff --git a/docs/commands/container.md b/docs/commands/container.md index f67966110e..f3c3a7edf0 100644 --- a/docs/commands/container.md +++ b/docs/commands/container.md @@ -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. diff --git a/docs/commands/datalab.md b/docs/commands/datalab.md index fe63552c4d..55c3b8beea 100644 --- a/docs/commands/datalab.md +++ b/docs/commands/datalab.md @@ -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. diff --git a/docs/commands/datawarehouse.md b/docs/commands/datawarehouse.md index 924a8df5eb..9fe24e0682 100644 --- a/docs/commands/datawarehouse.md +++ b/docs/commands/datawarehouse.md @@ -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. diff --git a/docs/commands/dns.md b/docs/commands/dns.md index 2701aa6953..08c69ea7ca 100644 --- a/docs/commands/dns.md +++ b/docs/commands/dns.md @@ -2,39 +2,6 @@ # Documentation for `scw dns` This API allows you to manage your domains, DNS zones and records. -- [TLS certificate management](#tls-certificate-management) - - [Create or get the DNS zone's TLS certificate](#create-or-get-the-dns-zone's-tls-certificate) - - [Delete a TLS certificate](#delete-a-tls-certificate) - - [Get a DNS zone's TLS certificate](#get-a-dns-zone's-tls-certificate) - - [List a user's TLS certificates](#list-a-user's-tls-certificates) -- [DNS records management](#dns-records-management) - - [Add a new DNS record](#add-a-new-dns-record) - - [Update records within a DNS zone](#update-records-within-a-dns-zone) - - [Clear records within a DNS zone](#clear-records-within-a-dns-zone) - - [Delete a DNS record](#delete-a-dns-record) - - [List records within a DNS zone](#list-records-within-a-dns-zone) - - [List name servers within a DNS zone](#list-name-servers-within-a-dns-zone) - - [Update a DNS record](#update-a-dns-record) - - [Update name servers within a DNS zone](#update-name-servers-within-a-dns-zone) -- [Transaction SIGnature key management](#transaction-signature-key-management) - - [Delete the DNS zone's TSIG key](#delete-the-dns-zone's-tsig-key) - - [Get the DNS zone's TSIG key](#get-the-dns-zone's-tsig-key) -- [DNS zones version management](#dns-zones-version-management) - - [Access differences from a specific DNS zone version](#access-differences-from-a-specific-dns-zone-version) - - [List versions of a DNS zone](#list-versions-of-a-dns-zone) - - [Restore a DNS zone version](#restore-a-dns-zone-version) - - [List records from a given version of a specific DNS zone](#list-records-from-a-given-version-of-a-specific-dns-zone) -- [DNS Zones management](#dns-zones-management) - - [Clone a DNS zone](#clone-a-dns-zone) - - [Create a DNS zone](#create-a-dns-zone) - - [Delete a DNS zone](#delete-a-dns-zone) - - [Export a raw DNS zone](#export-a-raw-dns-zone) - - [Import a raw DNS zone](#import-a-raw-dns-zone) - - [List DNS zones](#list-dns-zones) - - [Refresh a DNS zone](#refresh-a-dns-zone) - - [Update a DNS zone](#update-a-dns-zone) - - ## TLS certificate management TLS certificate management. diff --git a/docs/commands/domain.md b/docs/commands/domain.md index abe877fd02..fc086b3f52 100644 --- a/docs/commands/domain.md +++ b/docs/commands/domain.md @@ -2,45 +2,6 @@ # Documentation for `scw domain` Manage your domains and contacts. -- [Contact management](#contact-management) - - [Check if contacts are compatible with a domain or a TLD](#check-if-contacts-are-compatible-with-a-domain-or-a-tld) - - [Get a contact](#get-a-contact) - - [List contacts](#list-contacts) - - [Update contact](#update-contact) -- [Domain management](#domain-management) - - [Disable auto renew](#disable-auto-renew) - - [Disable a domain's DNSSEC](#disable-a-domain's-dnssec) - - [Enable auto renew](#enable-auto-renew) - - [Update domain DNSSEC](#update-domain-dnssec) - - [Get domain](#get-domain) - - [Get a domain's authorization code](#get-a-domain's-authorization-code) - - [List domains](#list-domains) - - [List domains that can be renewed](#list-domains-that-can-be-renewed) - - [Lock the transfer of a domain](#lock-the-transfer-of-a-domain) - - [Search available domains](#search-available-domains) - - [Unlock the transfer of a domain](#unlock-the-transfer-of-a-domain) - - [Update a domain's contacts](#update-a-domain's-contacts) -- [External domain management](#external-domain-management) - - [Delete an external domain](#delete-an-external-domain) - - [Register an external domain](#register-an-external-domain) -- [Domain host management](#domain-host-management) - - [Create a hostname for a domain](#create-a-hostname-for-a-domain) - - [Delete a domain's hostname](#delete-a-domain's-hostname) - - [List a domain's hostnames](#list-a-domain's-hostnames) - - [Update a domain's hostname](#update-a-domain's-hostname) -- [Domain order operations](#domain-order-operations) - - [Purchase domains](#purchase-domains) - - [Renew domains](#renew-domains) - - [Trade a domain's contact](#trade-a-domain's-contact) - - [Transfer a domain](#transfer-a-domain) -- [Task management](#task-management) - - [List tasks](#list-tasks) - - [List inbound domain transfers](#list-inbound-domain-transfers) - - [Retry the inbound transfer of a domain](#retry-the-inbound-transfer-of-a-domain) -- [TLD management](#tld-management) - - [List TLD offers](#list-tld-offers) - - ## Contact management Contact management. diff --git a/docs/commands/edge-services.md b/docs/commands/edge-services.md index bf32a4c52d..b509d5a2e5 100644 --- a/docs/commands/edge-services.md +++ b/docs/commands/edge-services.md @@ -2,66 +2,6 @@ # Documentation for `scw edge-services` Edge Services API -- [Backend-stage management commands](#backend-stage-management-commands) - - [Create backend stage](#create-backend-stage) - - [Delete backend stage](#delete-backend-stage) - - [Get backend stage](#get-backend-stage) - - [List backend stages](#list-backend-stages) - - [Update backend stage](#update-backend-stage) -- [Cache-stage management commands](#cache-stage-management-commands) - - [Create cache stage](#create-cache-stage) - - [Delete cache stage](#delete-cache-stage) - - [Get cache stage](#get-cache-stage) - - [List cache stages](#list-cache-stages) - - [Update cache stage](#update-cache-stage) -- [DNS-stage management commands](#dns-stage-management-commands) - - [Create DNS stage](#create-dns-stage) - - [Delete DNS stage](#delete-dns-stage) - - [Get DNS stage](#get-dns-stage) - - [List DNS stages](#list-dns-stages) - - [Update DNS stage](#update-dns-stage) -- [Pipeline management commands](#pipeline-management-commands) - - [Create pipeline](#create-pipeline) - - [Delete pipeline](#delete-pipeline) - - [Get pipeline](#get-pipeline) - - [List pipelines](#list-pipelines) - - [List Head stage for your pipeline.](#list-head-stage-for-your-pipeline.) - - [Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.](#configure-a-entry-point-to-your-pipeline.-you-must-specify-a-`head-stage`-to-form-a-stage-chain-that-goes-all-the-way-to-the-backend-stage-(origin),-so-the-http-request-will-be-processed-according-to-the-stages-you-created.) - - [Update pipeline](#update-pipeline) -- [Plan management commands](#plan-management-commands) - - [Delete plan](#delete-plan) - - [Get plan](#get-plan) - - [List plans](#list-plans) - - [Select plan](#select-plan) -- [Purge-request management commands](#purge-request-management-commands) - - [Create purge request](#create-purge-request) - - [Get purge request](#get-purge-request) - - [List purge requests](#list-purge-requests) -- [Route-rules management commands](#route-rules-management-commands) - - [Add route rules](#add-route-rules) - - [Edit all route rules of a route stage](#edit-all-route-rules-of-a-route-stage) - - [List route rules](#list-route-rules) - - [Set route rules](#set-route-rules) -- [Route-stage management commands](#route-stage-management-commands) - - [Create route stage](#create-route-stage) - - [Delete route stage](#delete-route-stage) - - [Get route stage](#get-route-stage) - - [List route stages](#list-route-stages) - - [Update route stage](#update-route-stage) -- [TLS-stage management commands](#tls-stage-management-commands) - - [Create TLS stage](#create-tls-stage) - - [Delete TLS stage](#delete-tls-stage) - - [Get TLS stage](#get-tls-stage) - - [List TLS stages](#list-tls-stages) - - [Update TLS stage](#update-tls-stage) -- [WAF-stage management commands](#waf-stage-management-commands) - - [Create WAF stage](#create-waf-stage) - - [Delete WAF stage](#delete-waf-stage) - - [Get WAF stage](#get-waf-stage) - - [List WAF stages](#list-waf-stages) - - [Update WAF stage](#update-waf-stage) - - ## Backend-stage management commands Backend-stage management commands. diff --git a/docs/commands/environmental-footprint.md b/docs/commands/environmental-footprint.md index e362bf7b84..690411497d 100644 --- a/docs/commands/environmental-footprint.md +++ b/docs/commands/environmental-footprint.md @@ -2,13 +2,6 @@ # Documentation for `scw environmental-footprint` Access and download impact reports and impact data for your Scaleway projects. Our API provides key metrics such as estimated carbon emissions and water usage to help monitor your environmental footprint. -- [Environmental impact data management commands](#environmental-impact-data-management-commands) - - [Retrieve detailed impact data](#retrieve-detailed-impact-data) -- [Environmental impact report management commands](#environmental-impact-report-management-commands) - - [Download PDF impact report](#download-pdf-impact-report) - - [Get available impact reports](#get-available-impact-reports) - - ## Environmental impact data management commands Environmental impact data management commands. diff --git a/docs/commands/feedback.md b/docs/commands/feedback.md index c9d5d2729d..a2c00130bd 100644 --- a/docs/commands/feedback.md +++ b/docs/commands/feedback.md @@ -2,10 +2,6 @@ # Documentation for `scw feedback` Send feedback to the Scaleway CLI Team! -- [Send a bug-report](#send-a-bug-report) -- [Send a feature request](#send-a-feature-request) - - ## Send a bug-report Send a bug-report to the Scaleway CLI team. diff --git a/docs/commands/file.md b/docs/commands/file.md index b7fed71ca9..1ca5caf71e 100644 --- a/docs/commands/file.md +++ b/docs/commands/file.md @@ -2,17 +2,6 @@ # Documentation for `scw file` This API allows you to manage your File Storage resources. -- [Attachment management](#attachment-management) - - [List filesystems attachments](#list-filesystems-attachments) -- [Filesystem management](#filesystem-management) - - [Create a new filesystem](#create-a-new-filesystem) - - [Delete a detached filesystem](#delete-a-detached-filesystem) - - [Get filesystem details](#get-filesystem-details) - - [List all filesystems](#list-all-filesystems) - - [Update filesystem properties](#update-filesystem-properties) -- [Filesystem-type management](#filesystem-type-management) - - ## Attachment management Attachment management. diff --git a/docs/commands/fip.md b/docs/commands/fip.md index 0708c3a93b..523fd5c7e2 100644 --- a/docs/commands/fip.md +++ b/docs/commands/fip.md @@ -2,21 +2,6 @@ # Documentation for `scw fip` This API allows you to manage your Elastic Metal servers' flexible public IP addresses. -- [Flexible IP management commands](#flexible-ip-management-commands) - - [Attach an existing flexible IP to a server](#attach-an-existing-flexible-ip-to-a-server) - - [Create a new flexible IP](#create-a-new-flexible-ip) - - [Delete an existing flexible IP](#delete-an-existing-flexible-ip) - - [Detach an existing flexible IP from a server](#detach-an-existing-flexible-ip-from-a-server) - - [Get an existing flexible IP](#get-an-existing-flexible-ip) - - [List flexible IPs](#list-flexible-ips) - - [Update an existing flexible IP](#update-an-existing-flexible-ip) -- [MAC address management commands](#mac-address-management-commands) - - [Generate a virtual MAC address on an existing flexible IP](#generate-a-virtual-mac-address-on-an-existing-flexible-ip) - - [Detach a given virtual MAC address from an existing flexible IP](#detach-a-given-virtual-mac-address-from-an-existing-flexible-ip) - - [Duplicate a virtual MAC address to another flexible IP](#duplicate-a-virtual-mac-address-to-another-flexible-ip) - - [Relocate an existing virtual MAC address to a different flexible IP](#relocate-an-existing-virtual-mac-address-to-a-different-flexible-ip) - - ## Flexible IP management commands A flexible IP can be attached to any Elastic Metal server within the same zone. diff --git a/docs/commands/function.md b/docs/commands/function.md index 574069ea27..a9fb08f034 100644 --- a/docs/commands/function.md +++ b/docs/commands/function.md @@ -2,48 +2,6 @@ # Documentation for `scw function` Function as a Service API. -- [Cron management commands](#cron-management-commands) - - [Create a new cron](#create-a-new-cron) - - [Delete an existing cron](#delete-an-existing-cron) - - [Get a cron](#get-a-cron) - - [List all crons](#list-all-crons) - - [Update an existing cron](#update-an-existing-cron) -- [Deploy a function](#deploy-a-function) -- [Domain management commands](#domain-management-commands) - - [Create a domain name binding](#create-a-domain-name-binding) - - [Delete a domain name binding](#delete-a-domain-name-binding) - - [Get a domain name binding](#get-a-domain-name-binding) - - [List all domain name bindings](#list-all-domain-name-bindings) -- [Function management commands](#function-management-commands) - - [Create a new function](#create-a-new-function) - - [Delete a function](#delete-a-function) - - [Deploy a function](#deploy-a-function) - - [Get a function](#get-a-function) - - [Get a download URL of a function](#get-a-download-url-of-a-function) - - [Get an upload URL of a function](#get-an-upload-url-of-a-function) - - [List all your functions](#list-all-your-functions) - - [Update an existing function](#update-an-existing-function) -- [Function namespace management commands](#function-namespace-management-commands) - - [Create a new namespace](#create-a-new-namespace) - - [Delete an existing namespace](#delete-an-existing-namespace) - - [Get a namespace](#get-a-namespace) - - [List all your namespaces](#list-all-your-namespaces) - - [Update an existing namespace](#update-an-existing-namespace) -- [Runtime management commands](#runtime-management-commands) - - [List function runtimes](#list-function-runtimes) -- [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 trigger](#create-a-trigger) - - [Delete a trigger](#delete-a-trigger) - - [Get a trigger](#get-a-trigger) - - [List all triggers](#list-all-triggers) - - [Update a trigger](#update-a-trigger) - - ## Cron management commands Cron management commands. diff --git a/docs/commands/help.md b/docs/commands/help.md index 07b9d45fea..1d676637a8 100644 --- a/docs/commands/help.md +++ b/docs/commands/help.md @@ -2,10 +2,6 @@ # Documentation for `scw help` Get help about how specific topics inside the CLI work -- [Get help about how date parsing works in the CLI](#get-help-about-how-date-parsing-works-in-the-cli) -- [Get help about how the CLI output works](#get-help-about-how-the-cli-output-works) - - ## Get help about how date parsing works in the CLI Date parsing diff --git a/docs/commands/iam.md b/docs/commands/iam.md index 62e0b61ccc..8f787c1ea4 100644 --- a/docs/commands/iam.md +++ b/docs/commands/iam.md @@ -2,89 +2,6 @@ # Documentation for `scw iam` This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources. -- [API keys management commands](#api-keys-management-commands) - - [Create an API key](#create-an-api-key) - - [Delete an API key](#delete-an-api-key) - - [Get an API key](#get-an-api-key) - - [List API keys](#list-api-keys) - - [Update an API key](#update-an-api-key) -- [Applications management commands](#applications-management-commands) - - [Create a new application](#create-a-new-application) - - [Delete an application](#delete-an-application) - - [Get a given application](#get-a-given-application) - - [List applications of an Organization](#list-applications-of-an-organization) - - [Update an application](#update-an-application) -- [Groups management commands](#groups-management-commands) - - [Add a user or an application to a group](#add-a-user-or-an-application-to-a-group) - - [Add multiple users and applications to a group](#add-multiple-users-and-applications-to-a-group) - - [Create a group](#create-a-group) - - [Delete a group](#delete-a-group) - - [Get a group](#get-a-group) - - [List groups](#list-groups) - - [Remove a user or an application from a group](#remove-a-user-or-an-application-from-a-group) - - [Overwrite users and applications of a group](#overwrite-users-and-applications-of-a-group) - - [Update a group](#update-a-group) -- [JWTs management commands](#jwts-management-commands) - - [Delete a JWT](#delete-a-jwt) - - [Get a JWT](#get-a-jwt) - - [List JWTs](#list-jwts) -- [Log management commands](#log-management-commands) - - [Get a log](#get-a-log) - - [List logs](#list-logs) -- [Organization-wide management commands](#organization-wide-management-commands) - - [Enable SAML Identity Provider for an Organization](#enable-saml-identity-provider-for-an-organization) - - [Enable SCIM for an Organization](#enable-scim-for-an-organization) - - [Get SAML Identity Provider configuration of an Organization](#get-saml-identity-provider-configuration-of-an-organization) - - [Get SCIM configuration of an Organization](#get-scim-configuration-of-an-organization) -- [Permission sets management commands](#permission-sets-management-commands) - - [List permission sets](#list-permission-sets) -- [Policies management commands](#policies-management-commands) - - [Clone a policy](#clone-a-policy) - - [Create a new policy](#create-a-new-policy) - - [Delete a policy](#delete-a-policy) - - [Get an existing policy](#get-an-existing-policy) - - [List policies of an Organization](#list-policies-of-an-organization) - - [Update an existing policy](#update-an-existing-policy) -- [Rules management commands](#rules-management-commands) - - [Create a rule for a specific IAM policy](#create-a-rule-for-a-specific-iam-policy) - - [Delete a rule for a specific IAM policy](#delete-a-rule-for-a-specific-iam-policy) - - [List rules of a given policy](#list-rules-of-a-given-policy) - - [Set rules of a given policy](#set-rules-of-a-given-policy) -- [SAML management commands](#saml-management-commands) - - [Disable SAML Identity Provider for an Organization](#disable-saml-identity-provider-for-an-organization) - - [Update SAML Identity Provider configuration](#update-saml-identity-provider-configuration) -- [SAML Certificates management commands](#saml-certificates-management-commands) - - [Add a SAML certificate](#add-a-saml-certificate) - - [Delete a SAML certificate](#delete-a-saml-certificate) - - [List SAML certificates](#list-saml-certificates) -- [SCIM management commands](#scim-management-commands) - - [Disable SCIM for an Organization](#disable-scim-for-an-organization) -- [SCIM tokens management commands](#scim-tokens-management-commands) - - [Create a SCIM token](#create-a-scim-token) - - [Delete a SCIM token](#delete-a-scim-token) - - [List SCIM tokens](#list-scim-tokens) -- [Security settings management commands](#security-settings-management-commands) - - [Get security settings of an Organization](#get-security-settings-of-an-organization) - - [Update the security settings of an Organization](#update-the-security-settings-of-an-organization) -- [SSH keys management commands](#ssh-keys-management-commands) - - [Create an SSH key](#create-an-ssh-key) - - [Delete an SSH key](#delete-an-ssh-key) - - [Get an SSH key](#get-an-ssh-key) - - [Initialize SSH key](#initialize-ssh-key) - - [List SSH keys](#list-ssh-keys) - - [Update an SSH key](#update-an-ssh-key) -- [Users management commands](#users-management-commands) - - [Create a new user](#create-a-new-user) - - [Delete a guest user from an Organization](#delete-a-guest-user-from-an-organization) - - [Get a given user](#get-a-given-user) - - [List users of an Organization](#list-users-of-an-organization) - - [Lock a member](#lock-a-member) - - [Unlock a member](#unlock-a-member) - - [Update a user](#update-a-user) - - [Update an user's password.](#update-an-user's-password.) - - [Update an user's username.](#update-an-user's-username.) - - ## API keys management commands API keys management commands. diff --git a/docs/commands/inference.md b/docs/commands/inference.md index f0dc52133c..6dc9ec860e 100644 --- a/docs/commands/inference.md +++ b/docs/commands/inference.md @@ -2,27 +2,6 @@ # Documentation for `scw inference` This API allows you to handle your Generative APIs - Dedicated Deployment services. -- [Deployment commands](#deployment-commands) - - [Create a deployment](#create-a-deployment) - - [Delete a deployment](#delete-a-deployment) - - [Get a deployment](#get-a-deployment) - - [Get the CA certificate](#get-the-ca-certificate) - - [List inference deployments](#list-inference-deployments) - - [Update a deployment](#update-a-deployment) -- [Endpoint management commands](#endpoint-management-commands) - - [Create an endpoint](#create-an-endpoint) - - [Delete an endpoint](#delete-an-endpoint) - - [Update an endpoint](#update-an-endpoint) -- [Models commands](#models-commands) - - [Delete a model](#delete-a-model) - - [Get a model](#get-a-model) - - [Import a model](#import-a-model) - - [List models](#list-models) - - [List available serverless models](#list-available-serverless-models) -- [Node types management commands](#node-types-management-commands) - - [List available node types](#list-available-node-types) - - ## Deployment commands Deployment commands. diff --git a/docs/commands/info.md b/docs/commands/info.md index dd26e08859..f4695c56fa 100644 --- a/docs/commands/info.md +++ b/docs/commands/info.md @@ -2,5 +2,3 @@ # Documentation for `scw info` Get info about current settings - - diff --git a/docs/commands/init.md b/docs/commands/init.md index 14afe0ea8e..8b791d2811 100644 --- a/docs/commands/init.md +++ b/docs/commands/init.md @@ -8,5 +8,3 @@ Default path for configuration file is based on the following priority order: - $HOME/.config/scw/config.yaml - $USERPROFILE/.config/scw/config.yaml - - diff --git a/docs/commands/instance.md b/docs/commands/instance.md index 784ec5c86f..3e70e90211 100644 --- a/docs/commands/instance.md +++ b/docs/commands/instance.md @@ -2,117 +2,6 @@ # Documentation for `scw instance` This API allows you to manage your CPU and GPU Instances. -- [Image management commands](#image-management-commands) - - [Create an Instance image](#create-an-instance-image) - - [Delete an Instance image](#delete-an-instance-image) - - [Get an Instance image](#get-an-instance-image) - - [List Instance images](#list-instance-images) - - [Update image](#update-image) - - [Wait for image to reach a stable state](#wait-for-image-to-reach-a-stable-state) -- [IP management commands](#ip-management-commands) - - [Attach an IP to a given server](#attach-an-ip-to-a-given-server) - - [Reserve a flexible IP](#reserve-a-flexible-ip) - - [Delete a flexible IP](#delete-a-flexible-ip) - - [Detach an ip from its server](#detach-an-ip-from-its-server) - - [Get a flexible IP](#get-a-flexible-ip) - - [List all flexible IPs](#list-all-flexible-ips) - - [Update a flexible IP](#update-a-flexible-ip) -- [Placement group management commands](#placement-group-management-commands) - - [Create a placement group](#create-a-placement-group) - - [Delete the specified placement group](#delete-the-specified-placement-group) - - [Get a placement group](#get-a-placement-group) - - [Get placement group servers](#get-placement-group-servers) - - [List placement groups](#list-placement-groups) - - [Set placement group](#set-placement-group) - - [Set placement group servers](#set-placement-group-servers) - - [Update a placement group](#update-a-placement-group) - - [Update placement group servers](#update-placement-group-servers) -- [Private NIC management commands](#private-nic-management-commands) - - [Create a private NIC connecting an Instance to a Private Network](#create-a-private-nic-connecting-an-instance-to-a-private-network) - - [Delete a private NIC](#delete-a-private-nic) - - [Get a private NIC](#get-a-private-nic) - - [List all private NICs](#list-all-private-nics) - - [Update a private NIC](#update-a-private-nic) -- [Security group management commands](#security-group-management-commands) - - [Remove all rules of a security group](#remove-all-rules-of-a-security-group) - - [Create a security group](#create-a-security-group) - - [Create rule](#create-rule) - - [Delete a security group](#delete-a-security-group) - - [Delete rule](#delete-rule) - - [Edit all rules of a security group](#edit-all-rules-of-a-security-group) - - [Get a security group](#get-a-security-group) - - [Get rule](#get-rule) - - [List security groups](#list-security-groups) - - [Get default rules](#get-default-rules) - - [List rules](#list-rules) - - [Update all the rules of a security group](#update-all-the-rules-of-a-security-group) - - [Update a security group](#update-a-security-group) - - [Update security group rule](#update-security-group-rule) -- [Instance management commands](#instance-management-commands) - - [Perform a raw API action on a server](#perform-a-raw-api-action-on-a-server) - - [Attach a filesystem volume to an Instance](#attach-a-filesystem-volume-to-an-instance) - - [Attach an IP to a server](#attach-an-ip-to-a-server) - - [Attach a volume to an Instance](#attach-a-volume-to-an-instance) - - [Backup server](#backup-server) - - [Connect to the serial console of an instance](#connect-to-the-serial-console-of-an-instance) - - [Create server](#create-server) - - [Delete server](#delete-server) - - [Detach a filesystem volume from an Instance](#detach-a-filesystem-volume-from-an-instance) - - [Detach an IP from a server](#detach-an-ip-from-a-server) - - [Detach a volume from an Instance](#detach-a-volume-from-an-instance) - - [Migrate server to IP mobility](#migrate-server-to-ip-mobility) - - [Get an Instance](#get-an-instance) - - [Get Instance compatible types](#get-instance-compatible-types) - - [Get your server rdp password and decrypt it using your ssh key](#get-your-server-rdp-password-and-decrypt-it-using-your-ssh-key) - - [List all Instances](#list-all-instances) - - [List Instance actions](#list-instance-actions) - - [Reboot server](#reboot-server) - - [SSH into a server](#ssh-into-a-server) - - [Put server in standby mode](#put-server-in-standby-mode) - - [Power on server](#power-on-server) - - [Power off server](#power-off-server) - - [Terminate server](#terminate-server) - - [Update an Instance](#update-an-instance) - - [Wait for server to reach a stable state](#wait-for-server-to-reach-a-stable-state) -- [Instance type management commands](#instance-type-management-commands) - - [Get availability](#get-availability) - - [List Instance types](#list-instance-types) -- [Snapshot management commands](#snapshot-management-commands) - - [Migrate a volume and/or snapshots to SBS (Scaleway Block Storage)](#migrate-a-volume-andor-snapshots-to-sbs-(scaleway-block-storage)) - - [Create a snapshot from a specified volume or from a QCOW2 file](#create-a-snapshot-from-a-specified-volume-or-from-a-qcow2-file) - - [Delete a snapshot](#delete-a-snapshot) - - [Export a snapshot](#export-a-snapshot) - - [Get a snapshot](#get-a-snapshot) - - [List snapshots](#list-snapshots) - - [Get a volume or snapshot's migration plan](#get-a-volume-or-snapshot's-migration-plan) - - [Update a snapshot](#update-a-snapshot) - - [Wait for snapshot to reach a stable state](#wait-for-snapshot-to-reach-a-stable-state) -- [SSH Utilities](#ssh-utilities) - - [Add a public key to a server](#add-a-public-key-to-a-server) - - [Fetch SSH keys from the console and install them on multiple servers](#fetch-ssh-keys-from-the-console-and-install-them-on-multiple-servers) - - [Install a ssh config with all your servers as host -It generate hosts for instance servers, baremetal, apple-silicon and bastions](#install-a-ssh-config-with-all-your-servers-as-host -it-generate-hosts-for-instance-servers,-baremetal,-apple-silicon-and-bastions) - - [List manually added public keys](#list-manually-added-public-keys) - - [Remove a manually added public key from a server](#remove-a-manually-added-public-key-from-a-server) -- [User data management commands](#user-data-management-commands) - - [Delete user data](#delete-user-data) - - [Get user data](#get-user-data) - - [List user data](#list-user-data) - - [Add/set user data](#addset-user-data) -- [Volume management commands](#volume-management-commands) - - [Migrate a volume and/or snapshots to SBS (Scaleway Block Storage)](#migrate-a-volume-andor-snapshots-to-sbs-(scaleway-block-storage)) - - [Create a volume](#create-a-volume) - - [Delete a volume](#delete-a-volume) - - [Get a volume](#get-a-volume) - - [List volumes](#list-volumes) - - [Get a volume or snapshot's migration plan](#get-a-volume-or-snapshot's-migration-plan) - - [Update a volume](#update-a-volume) - - [Wait for volume to reach a stable state](#wait-for-volume-to-reach-a-stable-state) -- [Volume type management commands](#volume-type-management-commands) - - [List volume types](#list-volume-types) - - ## Image management commands Images are backups of your Instances. diff --git a/docs/commands/interlink.md b/docs/commands/interlink.md index 7b4da1ec0b..08f8b486e0 100644 --- a/docs/commands/interlink.md +++ b/docs/commands/interlink.md @@ -2,33 +2,6 @@ # Documentation for `scw interlink` This API allows you to manage your InterLink services. -- [Connection commands](#connection-commands) -- [Link commands](#link-commands) - - [Attach a routing policy](#attach-a-routing-policy) - - [Attach a VPC](#attach-a-vpc) - - [Create a link](#create-a-link) - - [Delete a link](#delete-a-link) - - [Detach a routing policy](#detach-a-routing-policy) - - [Detach a VPC](#detach-a-vpc) - - [Disable route propagation](#disable-route-propagation) - - [Enable route propagation](#enable-route-propagation) - - [Get a link](#get-a-link) - - [List links](#list-links) - - [Update a link](#update-a-link) -- [Partner commands](#partner-commands) - - [Get a partner](#get-a-partner) - - [List available partners](#list-available-partners) -- [PoP commands](#pop-commands) - - [Get a PoP](#get-a-pop) - - [List PoPs](#list-pops) -- [Routing policy commands](#routing-policy-commands) - - [Create a routing policy](#create-a-routing-policy) - - [Delete a routing policy](#delete-a-routing-policy) - - [Get routing policy](#get-routing-policy) - - [List routing policies](#list-routing-policies) - - [Update a routing policy](#update-a-routing-policy) - - ## Connection commands Connection commands. diff --git a/docs/commands/iot.md b/docs/commands/iot.md index d72e8e2fc6..9db54e118a 100644 --- a/docs/commands/iot.md +++ b/docs/commands/iot.md @@ -2,41 +2,6 @@ # Documentation for `scw iot` This API allows you to manage your IoT hubs and devices. -- [IoT Device commands](#iot-device-commands) - - [Add a device](#add-a-device) - - [Remove a device](#remove-a-device) - - [Disable a device](#disable-a-device) - - [Enable a device](#enable-a-device) - - [Get a device](#get-a-device) - - [Get a device's certificate](#get-a-device's-certificate) - - [Get a device's metrics](#get-a-device's-metrics) - - [List devices](#list-devices) - - [Renew a device certificate](#renew-a-device-certificate) - - [Set a custom certificate on a device](#set-a-custom-certificate-on-a-device) - - [Update a device](#update-a-device) -- [IoT Hub commands](#iot-hub-commands) - - [Create a hub](#create-a-hub) - - [Delete a hub](#delete-a-hub) - - [Disable a hub](#disable-a-hub) - - [Enable a hub](#enable-a-hub) - - [Get a hub](#get-a-hub) - - [Get the certificate authority of a hub](#get-the-certificate-authority-of-a-hub) - - [List hubs](#list-hubs) - - [Set the certificate authority of a hub](#set-the-certificate-authority-of-a-hub) - - [Update a hub](#update-a-hub) -- [IoT Network commands](#iot-network-commands) - - [Create a new network](#create-a-new-network) - - [Delete a Network](#delete-a-network) - - [Retrieve a specific network](#retrieve-a-specific-network) - - [List the networks](#list-the-networks) -- [IoT Route commands](#iot-route-commands) - - [Create a route](#create-a-route) - - [Delete a route](#delete-a-route) - - [Get a route](#get-a-route) - - [List routes](#list-routes) - - [Update a route](#update-a-route) - - ## IoT Device commands IoT Device commands. diff --git a/docs/commands/ipam.md b/docs/commands/ipam.md index e2329ca2b3..b34af1a981 100644 --- a/docs/commands/ipam.md +++ b/docs/commands/ipam.md @@ -2,16 +2,6 @@ # Documentation for `scw ipam` This API allows you to manage your Scaleway IP addresses with our IP Address Management tool. -- [IP management command](#ip-management-command) - - [Reserve a new IP](#reserve-a-new-ip) - - [Release an IP](#release-an-ip) - - [Get an IP](#get-an-ip) - - [List existing IPs](#list-existing-ips) - - [Update an IP](#update-an-ip) -- [Management command for sets of IPs](#management-command-for-sets-of-ips) - - [Release ipam resources](#release-ipam-resources) - - ## IP management command *ips_long. diff --git a/docs/commands/jobs.md b/docs/commands/jobs.md index c558b4750f..1acd87f6fc 100644 --- a/docs/commands/jobs.md +++ b/docs/commands/jobs.md @@ -2,32 +2,6 @@ # Documentation for `scw jobs` This API allows you to manage your Serverless Jobs. -- [](#) - - [Create a new job definition in a specified Project](#create-a-new-job-definition-in-a-specified-project) - - [Delete an existing job definition by its unique identifier](#delete-an-existing-job-definition-by-its-unique-identifier) - - [Get a job definition by its unique identifier](#get-a-job-definition-by-its-unique-identifier) - - [List all your job definitions with filters](#list-all-your-job-definitions-with-filters) - - [Run an existing job definition using its unique identifier and create a new job run](#run-an-existing-job-definition-using-its-unique-identifier-and-create-a-new-job-run) - - [Update an existing job definition associated with the specified unique identifier](#update-an-existing-job-definition-associated-with-the-specified-unique-identifier) -- [](#) - - [Get a job run by its unique identifier](#get-a-job-run-by-its-unique-identifier) - - [List all job runs with filters](#list-all-job-runs-with-filters) - - [Stop a job run using its unique identifier](#stop-a-job-run-using-its-unique-identifier) - - [Wait for a job run to reach a stable state](#wait-for-a-job-run-to-reach-a-stable-state) -- [](#) - - [Create a secret reference within a job definition](#create-a-secret-reference-within-a-job-definition) - - [Delete a secret reference within a job definition](#delete-a-secret-reference-within-a-job-definition) - - [Get a secret references within a job definition](#get-a-secret-references-within-a-job-definition) - - [List secrets references within a job definition](#list-secrets-references-within-a-job-definition) - - [Update a secret reference within a job definition](#update-a-secret-reference-within-a-job-definition) -- [](#) - - [Create a trigger](#create-a-trigger) - - [Delete a trigger](#delete-a-trigger) - - [Get a trigger](#get-a-trigger) - - [List triggers of a job definition](#list-triggers-of-a-job-definition) - - [Update a trigger](#update-a-trigger) - - ## diff --git a/docs/commands/k8s.md b/docs/commands/k8s.md index 0ff4ee751d..e9aeed08d4 100644 --- a/docs/commands/k8s.md +++ b/docs/commands/k8s.md @@ -2,56 +2,6 @@ # Documentation for `scw k8s` This API allows you to manage Kubernetes Kapsule and Kosmos clusters. -- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) - - [Add new ACLs](#add-new-acls) - - [Delete an existing ACL](#delete-an-existing-acl) - - [List ACLs](#list-acls) - - [Set new ACLs](#set-new-acls) -- [Kapsule cluster management commands](#kapsule-cluster-management-commands) - - [Create a new Cluster](#create-a-new-cluster) - - [Delete a Cluster](#delete-a-cluster) - - [Get a Cluster](#get-a-cluster) - - [List Clusters](#list-clusters) - - [List available cluster types for a cluster](#list-available-cluster-types-for-a-cluster) - - [List available versions for a Cluster](#list-available-versions-for-a-cluster) - - [Reset the admin token of a Cluster](#reset-the-admin-token-of-a-cluster) - - [Change the Cluster type](#change-the-cluster-type) - - [Update a Cluster](#update-a-cluster) - - [Upgrade a Cluster](#upgrade-a-cluster) - - [Wait for a cluster to reach a stable state](#wait-for-a-cluster-to-reach-a-stable-state) -- [Cluster type management commands](#cluster-type-management-commands) - - [List cluster types](#list-cluster-types) -- [Manage your Kubernetes Kapsule cluster's kubeconfig files](#manage-your-kubernetes-kapsule-cluster's-kubeconfig-files) - - [Retrieve a kubeconfig](#retrieve-a-kubeconfig) - - [Install a kubeconfig](#install-a-kubeconfig) - - [Uninstall a kubeconfig](#uninstall-a-kubeconfig) -- [Kapsule node management commands](#kapsule-node-management-commands) - - [Delete a Node in a Cluster](#delete-a-node-in-a-cluster) - - [Get a Node in a Cluster](#get-a-node-in-a-cluster) - - [List Nodes in a Cluster](#list-nodes-in-a-cluster) - - [Reboot a Node in a Cluster](#reboot-a-node-in-a-cluster) - - [Replace a Node in a Cluster](#replace-a-node-in-a-cluster) - - [Wait for a node to reach a stable state](#wait-for-a-node-to-reach-a-stable-state) -- [Kapsule pool management commands](#kapsule-pool-management-commands) - - [Add an external node to a Kosmos Pool](#add-an-external-node-to-a-kosmos-pool) - - [Create a new Pool in a Cluster](#create-a-new-pool-in-a-cluster) - - [Delete a Pool in a Cluster](#delete-a-pool-in-a-cluster) - - [Get a Pool in a Cluster](#get-a-pool-in-a-cluster) - - [List Pools in a Cluster](#list-pools-in-a-cluster) - - [Remove a label from a Pool](#remove-a-label-from-a-pool) - - [Remove a startup taint from a Pool](#remove-a-startup-taint-from-a-pool) - - [Remove a taint from a Pool](#remove-a-taint-from-a-pool) - - [Apply a label to a Pool](#apply-a-label-to-a-pool) - - [Apply a startup taint to a Pool](#apply-a-startup-taint-to-a-pool) - - [Apply a taint to a Pool](#apply-a-taint-to-a-pool) - - [Update a Pool in a Cluster](#update-a-pool-in-a-cluster) - - [Upgrade a Pool in a Cluster](#upgrade-a-pool-in-a-cluster) - - [Wait for a pool to reach a stable state](#wait-for-a-pool-to-reach-a-stable-state) -- [Available Kubernetes versions commands](#available-kubernetes-versions-commands) - - [Get a Version](#get-a-version) - - [List all available Versions](#list-all-available-versions) - - ## Access Control List (ACL) management commands Network Access Control Lists (ACLs) allow you to manage inbound network traffic by setting up ACL rules. diff --git a/docs/commands/kafka.md b/docs/commands/kafka.md index 1b2e046376..55376b5a8e 100644 --- a/docs/commands/kafka.md +++ b/docs/commands/kafka.md @@ -2,24 +2,6 @@ # Documentation for `scw kafka` This API allows you to manage your Clusters for Apache Kafka®. This product is currently in Public Beta. -- [Cluster management commands](#cluster-management-commands) - - [Create a Kafka cluster](#create-a-kafka-cluster) - - [Delete a Kafka cluster](#delete-a-kafka-cluster) - - [Get a Kafka cluster](#get-a-kafka-cluster) - - [Get a Kafka cluster's certificate authority](#get-a-kafka-cluster's-certificate-authority) - - [List Kafka clusters](#list-kafka-clusters) - - [Renew the Kafka cluster's certificate authority](#renew-the-kafka-cluster's-certificate-authority) - - [Update a Kafka cluster](#update-a-kafka-cluster) -- [Endpoints management commands](#endpoints-management-commands) -- [Node types management commands](#node-types-management-commands) - - [List available node types](#list-available-node-types) -- [Kafka users management commands](#kafka-users-management-commands) - - [List kafka resources](#list-kafka-resources) - - [Update kafka resources](#update-kafka-resources) -- [Kafka version management commands](#kafka-version-management-commands) - - [List Kafka versions](#list-kafka-versions) - - ## Cluster management commands A Kafka cluster is composed of one or multiple dedicated compute nodes running a single Kafka broker. diff --git a/docs/commands/keymanager.md b/docs/commands/keymanager.md index 9c840a480d..df39aeb26b 100644 --- a/docs/commands/keymanager.md +++ b/docs/commands/keymanager.md @@ -2,24 +2,6 @@ # Documentation for `scw keymanager` This API allows you to conveniently store and use cryptographic keys. -- [Key management commands](#key-management-commands) - - [Create a key](#create-a-key) - - [Decrypt an encrypted payload](#decrypt-an-encrypted-payload) - - [Delete a key](#delete-a-key) - - [Delete key material](#delete-key-material) - - [Disable key](#disable-key) - - [Enable key](#enable-key) - - [Encrypt a payload](#encrypt-a-payload) - - [Create a data encryption key](#create-a-data-encryption-key) - - [Get key metadata](#get-key-metadata) - - [Import key material](#import-key-material) - - [List keys](#list-keys) - - [Apply key protection](#apply-key-protection) - - [Rotate a key](#rotate-a-key) - - [Remove key protection](#remove-key-protection) - - [Update a key](#update-a-key) - - ## Key management commands Keys are logical containers which store cryptographic keys. diff --git a/docs/commands/lb.md b/docs/commands/lb.md index ca59018334..a8129e56aa 100644 --- a/docs/commands/lb.md +++ b/docs/commands/lb.md @@ -2,73 +2,6 @@ # Documentation for `scw lb` This API allows you to manage your Scaleway Load Balancer services. -- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) - - [Create an ACL for a given frontend](#create-an-acl-for-a-given-frontend) - - [Delete an ACL](#delete-an-acl) - - [Get an ACL](#get-an-acl) - - [List ACLs for a given frontend](#list-acls-for-a-given-frontend) - - [Define all ACLs for a given frontend](#define-all-acls-for-a-given-frontend) - - [Update an ACL](#update-an-acl) -- [Backend management commands](#backend-management-commands) - - [Add a set of backend servers to a given backend](#add-a-set-of-backend-servers-to-a-given-backend) - - [Create a backend for a given Load Balancer](#create-a-backend-for-a-given-load-balancer) - - [Delete a backend of a given Load Balancer](#delete-a-backend-of-a-given-load-balancer) - - [Get a backend of a given Load Balancer](#get-a-backend-of-a-given-load-balancer) - - [List the backends of a given Load Balancer](#list-the-backends-of-a-given-load-balancer) - - [List backend server statistics](#list-backend-server-statistics) - - [Remove a set of servers for a given backend](#remove-a-set-of-servers-for-a-given-backend) - - [Define all backend servers for a given backend](#define-all-backend-servers-for-a-given-backend) - - [Update a backend of a given Load Balancer](#update-a-backend-of-a-given-load-balancer) - - [Update a health check for a given backend](#update-a-health-check-for-a-given-backend) -- [TLS certificate management commands](#tls-certificate-management-commands) - - [Create an SSL/TLS certificate](#create-an-ssltls-certificate) - - [Delete an SSL/TLS certificate](#delete-an-ssltls-certificate) - - [Get an SSL/TLS certificate](#get-an-ssltls-certificate) - - [List all SSL/TLS certificates on a given Load Balancer](#list-all-ssltls-certificates-on-a-given-load-balancer) - - [Update an SSL/TLS certificate](#update-an-ssltls-certificate) -- [Frontend management commands](#frontend-management-commands) - - [Create a frontend in a given Load Balancer](#create-a-frontend-in-a-given-load-balancer) - - [Delete a frontend](#delete-a-frontend) - - [Get a frontend](#get-a-frontend) - - [List frontends of a given Load Balancer](#list-frontends-of-a-given-load-balancer) - - [Update a frontend](#update-a-frontend) -- [IP management commands](#ip-management-commands) - - [Create an IP address](#create-an-ip-address) - - [Delete an IP address](#delete-an-ip-address) - - [Get an IP address](#get-an-ip-address) - - [List IP addresses](#list-ip-addresses) - - [Update an IP address](#update-an-ip-address) -- [Load balancer management commands](#load-balancer-management-commands) - - [Create a Load Balancer](#create-a-load-balancer) - - [Delete a Load Balancer](#delete-a-load-balancer) - - [Get a Load Balancer](#get-a-load-balancer) - - [Get usage statistics of a given Load Balancer](#get-usage-statistics-of-a-given-load-balancer) - - [List Load Balancers](#list-load-balancers) - - [Migrate a Load Balancer](#migrate-a-load-balancer) - - [Update a Load Balancer](#update-a-load-balancer) - - [Wait for a load balancer to reach a stable state](#wait-for-a-load-balancer-to-reach-a-stable-state) -- [Load balancer types management commands](#load-balancer-types-management-commands) - - [List all Load Balancer offer types](#list-all-load-balancer-offer-types) -- [Private networks management commands](#private-networks-management-commands) - - [Attach a Load Balancer to a Private Network](#attach-a-load-balancer-to-a-private-network) - - [Detach Load Balancer from Private Network](#detach-load-balancer-from-private-network) - - [List Private Networks attached to a Load Balancer](#list-private-networks-attached-to-a-load-balancer) -- [Route rules management commands](#route-rules-management-commands) - - [Create a route](#create-a-route) - - [Delete a route](#delete-a-route) - - [Get a route](#get-a-route) - - [List all routes](#list-all-routes) - - [Update a route](#update-a-route) -- [Subscriber management commands](#subscriber-management-commands) - - [Create a subscriber](#create-a-subscriber) - - [Delete a subscriber](#delete-a-subscriber) - - [Get a subscriber](#get-a-subscriber) - - [List all subscribers](#list-all-subscribers) - - [Subscribe a subscriber to alerts for a given Load Balancer](#subscribe-a-subscriber-to-alerts-for-a-given-load-balancer) - - [Unsubscribe a subscriber from alerts for a given Load Balancer](#unsubscribe-a-subscriber-from-alerts-for-a-given-load-balancer) - - [Update a subscriber](#update-a-subscriber) - - ## Access Control List (ACL) management commands Access Control List (ACL) management commands. diff --git a/docs/commands/login.md b/docs/commands/login.md index e3bec40508..6883c9d074 100644 --- a/docs/commands/login.md +++ b/docs/commands/login.md @@ -5,5 +5,3 @@ A webpage will open while the CLI will wait for a response. Once you connected to Scaleway, the profile should be configured. - - diff --git a/docs/commands/marketplace.md b/docs/commands/marketplace.md index 8a23645374..2716944531 100644 --- a/docs/commands/marketplace.md +++ b/docs/commands/marketplace.md @@ -2,20 +2,6 @@ # Documentation for `scw marketplace` This API allows you to find available images for use when launching a Scaleway Instance. -- [Marketplace category management commands](#marketplace-category-management-commands) - - [Get a specific category](#get-a-specific-category) - - [List existing image categories](#list-existing-image-categories) -- [Marketplace images management commands](#marketplace-images-management-commands) - - [Get a specific marketplace image](#get-a-specific-marketplace-image) - - [List marketplace images](#list-marketplace-images) -- [Marketplace local images management commands](#marketplace-local-images-management-commands) - - [Get a specific local image by ID](#get-a-specific-local-image-by-id) - - [List local images from a specific image or version](#list-local-images-from-a-specific-image-or-version) -- [Marketplace version management commands](#marketplace-version-management-commands) - - [Get a specific image version](#get-a-specific-image-version) - - [List versions of an Image](#list-versions-of-an-image) - - ## Marketplace category management commands Marketplace category management commands. diff --git a/docs/commands/mcp.md b/docs/commands/mcp.md index f42ca671a9..4fab2bb609 100644 --- a/docs/commands/mcp.md +++ b/docs/commands/mcp.md @@ -2,12 +2,6 @@ # Documentation for `scw mcp` Commands for managing the MCP server that exposes Scaleway CLI commands as AI tools. -- [MCP server management commands](#mcp-server-management-commands) - - [List available MCP resources](#list-available-mcp-resources) - - [List available MCP tools](#list-available-mcp-tools) - - [Start the MCP server](#start-the-mcp-server) - - ## MCP server management commands Commands for managing the MCP server that exposes Scaleway CLI commands as AI tools. diff --git a/docs/commands/mnq.md b/docs/commands/mnq.md index 5a15d2413a..a307d1d15d 100644 --- a/docs/commands/mnq.md +++ b/docs/commands/mnq.md @@ -2,37 +2,6 @@ # Documentation for `scw mnq` These APIs allow you to manage your Messaging and Queuing NATS, Queues and Topics and Events services. -- [MnQ NATS commands](#mnq-nats-commands) - - [Create a NATS account](#create-a-nats-account) - - [Create a new context for natscli](#create-a-new-context-for-natscli) - - [Create NATS credentials](#create-nats-credentials) - - [Delete a NATS account](#delete-a-nats-account) - - [Delete NATS credentials](#delete-nats-credentials) - - [Get a NATS account](#get-a-nats-account) - - [Get NATS credentials](#get-nats-credentials) - - [List NATS accounts](#list-nats-accounts) - - [List NATS credentials](#list-nats-credentials) - - [Update the name of a NATS account](#update-the-name-of-a-nats-account) -- [MnQ Topics and Events commands](#mnq-topics-and-events-commands) - - [Activate Topics and Events](#activate-topics-and-events) - - [Create Topics and Events credentials](#create-topics-and-events-credentials) - - [Deactivate Topics and Events](#deactivate-topics-and-events) - - [Delete Topics and Events credentials](#delete-topics-and-events-credentials) - - [Get Topics and Events credentials](#get-topics-and-events-credentials) - - [Get Topics and Events info](#get-topics-and-events-info) - - [List Topics and Events credentials](#list-topics-and-events-credentials) - - [Update Topics and Events credentials](#update-topics-and-events-credentials) -- [MnQ Queues commands](#mnq-queues-commands) - - [Activate Queues](#activate-queues) - - [Create Queues credentials](#create-queues-credentials) - - [Deactivate Queues](#deactivate-queues) - - [Delete Queues credentials](#delete-queues-credentials) - - [Get Queues credentials](#get-queues-credentials) - - [Get Queues info](#get-queues-info) - - [List Queues credentials](#list-queues-credentials) - - [Update Queues credentials](#update-queues-credentials) - - ## MnQ NATS commands MnQ NATS commands. diff --git a/docs/commands/mongodb.md b/docs/commands/mongodb.md index 795fcd83ac..b38b6d57cc 100644 --- a/docs/commands/mongodb.md +++ b/docs/commands/mongodb.md @@ -2,37 +2,6 @@ # Documentation for `scw mongodb` This API allows you to manage your Managed Databases for MongoDB®. -- [Endpoint management commands](#endpoint-management-commands) - - [Create a new Instance endpoint](#create-a-new-instance-endpoint) - - [Delete a Database Instance endpoint](#delete-a-database-instance-endpoint) -- [Instance management commands](#instance-management-commands) - - [Create a MongoDB® Database Instance](#create-a-mongodb®-database-instance) - - [Delete a MongoDB® Database Instance](#delete-a-mongodb®-database-instance) - - [Get a MongoDB® Database Instance](#get-a-mongodb®-database-instance) - - [Get the certificate of a Database Instance](#get-the-certificate-of-a-database-instance) - - [List MongoDB® Database Instances](#list-mongodb®-database-instances) - - [Update a MongoDB® Database Instance](#update-a-mongodb®-database-instance) - - [Upgrade a Database Instance](#upgrade-a-database-instance) - - [Wait for an instance to reach a stable state](#wait-for-an-instance-to-reach-a-stable-state) -- [Node types management commands](#node-types-management-commands) - - [List available node types](#list-available-node-types) -- [Snapshot management commands](#snapshot-management-commands) - - [Create a Database Instance snapshot](#create-a-database-instance-snapshot) - - [Delete a Database Instance snapshot](#delete-a-database-instance-snapshot) - - [Get a Database Instance snapshot](#get-a-database-instance-snapshot) - - [List snapshots](#list-snapshots) - - [Restore a Database Instance snapshot](#restore-a-database-instance-snapshot) - - [Update a Database Instance snapshot](#update-a-database-instance-snapshot) -- [User management commands](#user-management-commands) - - [Create an user on a Database Instance](#create-an-user-on-a-database-instance) - - [Delete a user on a Database Instance](#delete-a-user-on-a-database-instance) - - [List users of a Database Instance](#list-users-of-a-database-instance) - - [Apply user roles](#apply-user-roles) - - [Update a user on a Database Instance](#update-a-user-on-a-database-instance) -- [MongoDB® version management commands](#mongodb®-version-management-commands) - - [List available MongoDB® versions](#list-available-mongodb®-versions) - - ## Endpoint management commands Instance endpoints enable connection to your instance. diff --git a/docs/commands/object.md b/docs/commands/object.md index 4a6c9f4d9d..51496495a7 100644 --- a/docs/commands/object.md +++ b/docs/commands/object.md @@ -2,17 +2,6 @@ # Documentation for `scw object` Object-storage utils -- [Manage S3 buckets](#manage-s3-buckets) - - [Create an S3 bucket](#create-an-s3-bucket) - - [Delete an S3 bucket](#delete-an-s3-bucket) - - [Get information about an S3 bucket](#get-information-about-an-s3-bucket) - - [List S3 buckets](#list-s3-buckets) - - [Update an S3 bucket](#update-an-s3-bucket) -- [Manage configuration files for popular S3 tools](#manage-configuration-files-for-popular-s3-tools) - - [Generate a S3 tool configuration file](#generate-a-s3-tool-configuration-file) - - [Install a S3 tool configuration file to its default location](#install-a-s3-tool-configuration-file-to-its-default-location) - - ## Manage S3 buckets Manage S3 buckets creation, deletion and updates to properties like tags, ACL and versioning. diff --git a/docs/commands/partner.md b/docs/commands/partner.md index c31e19ab1d..a99ce229f5 100644 --- a/docs/commands/partner.md +++ b/docs/commands/partner.md @@ -2,15 +2,6 @@ # Documentation for `scw partner` Scaleway Partner API ( for partner only ). -- [Organization management commands](#organization-management-commands) - - [Create a new organization](#create-a-new-organization) - - [Get an organization](#get-an-organization) - - [List Organizations](#list-organizations) - - [Lock an organization](#lock-an-organization) - - [Unlock an organization](#unlock-an-organization) - - [Update an organization](#update-an-organization) - - ## Organization management commands Organization management commands. diff --git a/docs/commands/product-catalog.md b/docs/commands/product-catalog.md index 8cea8a4f63..0601f45f4c 100644 --- a/docs/commands/product-catalog.md +++ b/docs/commands/product-catalog.md @@ -2,10 +2,6 @@ # Documentation for `scw product-catalog` Product Catalog API -- [Scaleway Product Catalog API](#scaleway-product-catalog-api) - - [List all available products](#list-all-available-products) - - ## Scaleway Product Catalog API Scaleway's Product Catalog is an extensive list of the Scaleway products. diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md index 0359fc897c..4839632570 100644 --- a/docs/commands/rdb.md +++ b/docs/commands/rdb.md @@ -2,88 +2,6 @@ # Documentation for `scw rdb` This API allows you to manage your Managed Databases for PostgreSQL and MySQL. -- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) - - [Add an ACL rule to a Database Instance](#add-an-acl-rule-to-a-database-instance) - - [Delete ACL rules of a Database Instance](#delete-acl-rules-of-a-database-instance) - - [Edit a database instance's ACL](#edit-a-database-instance's-acl) - - [List ACL rules of a Database Instance](#list-acl-rules-of-a-database-instance) - - [Set ACL rules for a Database Instance](#set-acl-rules-for-a-database-instance) -- [Backup management commands](#backup-management-commands) - - [Create a database backup](#create-a-database-backup) - - [Delete a database backup](#delete-a-database-backup) - - [Download a backup locally](#download-a-backup-locally) - - [Export a database backup](#export-a-database-backup) - - [Get a database backup](#get-a-database-backup) - - [List database backups](#list-database-backups) - - [Restore a database backup](#restore-a-database-backup) - - [Update a database backup](#update-a-database-backup) - - [Wait for a backup to reach a stable state](#wait-for-a-backup-to-reach-a-stable-state) -- [Database management commands](#database-management-commands) - - [Create a database in a Database Instance](#create-a-database-in-a-database-instance) - - [Delete a database in a Database Instance](#delete-a-database-in-a-database-instance) - - [Gets the URL to connect to the Database](#gets-the-url-to-connect-to-the-database) - - [List databases in a Database Instance](#list-databases-in-a-database-instance) -- [Endpoint management](#endpoint-management) - - [Create a new Database Instance endpoint](#create-a-new-database-instance-endpoint) - - [Delete a Database Instance endpoint](#delete-a-database-instance-endpoint) - - [Get a Database Instance endpoint](#get-a-database-instance-endpoint) - - [Lists a Database Instance's endpoints](#lists-a-database-instance's-endpoints) - - [Migrate an existing instance endpoint to another instance](#migrate-an-existing-instance-endpoint-to-another-instance) -- [Database engines commands](#database-engines-commands) - - [List available database engines](#list-available-database-engines) - - [List available settings from an engine.](#list-available-settings-from-an-engine.) -- [Instance management commands](#instance-management-commands) - - [Clone a Database Instance](#clone-a-database-instance) - - [Connect to an instance using locally installed CLI](#connect-to-an-instance-using-locally-installed-cli) - - [Create a Database Instance](#create-a-database-instance) - - [Delete a Database Instance](#delete-a-database-instance) - - [Get a Database Instance](#get-a-database-instance) - - [Get the TLS certificate of a Database Instance](#get-the-tls-certificate-of-a-database-instance) - - [[deprecated] Get Database Instance metrics](#[deprecated]-get-database-instance-metrics) - - [List Database Instances](#list-database-instances) - - [Renew the TLS certificate of a Database Instance](#renew-the-tls-certificate-of-a-database-instance) - - [Restart Database Instance](#restart-database-instance) - - [Update an instance](#update-an-instance) - - [Upgrade a Database Instance](#upgrade-a-database-instance) - - [Wait for an instance to reach a stable state](#wait-for-an-instance-to-reach-a-stable-state) -- [Instance logs management commands](#instance-logs-management-commands) - - [Download logs from a database instance](#download-logs-from-a-database-instance) - - [Get given logs of a Database Instance](#get-given-logs-of-a-database-instance) - - [List available logs of a Database Instance](#list-available-logs-of-a-database-instance) - - [List remote Database Instance logs details](#list-remote-database-instance-logs-details) - - [Prepare logs of a Database Instance](#prepare-logs-of-a-database-instance) - - [Purge remote Database Instance logs](#purge-remote-database-instance-logs) -- [Node types management commands](#node-types-management-commands) - - [List available node types](#list-available-node-types) -- [User privileges management commands](#user-privileges-management-commands) - - [List user privileges for a database](#list-user-privileges-for-a-database) - - [Set user privileges for a database](#set-user-privileges-for-a-database) -- [Read replica management](#read-replica-management) - - [Create a Read Replica](#create-a-read-replica) - - [Create an endpoint for a Read Replica](#create-an-endpoint-for-a-read-replica) - - [Delete a Read Replica](#delete-a-read-replica) - - [Get a Read Replica](#get-a-read-replica) - - [Resync a Read Replica](#resync-a-read-replica) -- [Setting management](#setting-management) - - [Add Database Instance advanced settings](#add-database-instance-advanced-settings) - - [Delete Database Instance advanced settings](#delete-database-instance-advanced-settings) - - [Edit Database Instance settings in your default editor](#edit-database-instance-settings-in-your-default-editor) - - [Set Database Instance advanced settings](#set-database-instance-advanced-settings) -- [Block snapshot management](#block-snapshot-management) - - [Create a Database Instance snapshot](#create-a-database-instance-snapshot) - - [Delete a Database Instance snapshot](#delete-a-database-instance-snapshot) - - [Get a Database Instance snapshot](#get-a-database-instance-snapshot) - - [List snapshots](#list-snapshots) - - [Create a new Database Instance from a snapshot](#create-a-new-database-instance-from-a-snapshot) - - [Update a Database Instance snapshot](#update-a-database-instance-snapshot) -- [User management commands](#user-management-commands) - - [Create a user for a Database Instance](#create-a-user-for-a-database-instance) - - [Delete a user on a Database Instance](#delete-a-user-on-a-database-instance) - - [Gets the URL to connect to the Database](#gets-the-url-to-connect-to-the-database) - - [List users of a Database Instance](#list-users-of-a-database-instance) - - [Update a user on a Database Instance](#update-a-user-on-a-database-instance) - - ## Access Control List (ACL) management commands Network Access Control Lists allow you to control incoming network traffic by setting up ACL rules. diff --git a/docs/commands/redis.md b/docs/commands/redis.md index 76c18d9e04..38d850b93e 100644 --- a/docs/commands/redis.md +++ b/docs/commands/redis.md @@ -2,41 +2,6 @@ # Documentation for `scw redis` This API allows you to manage your Managed Databases for Redis™. -- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands) - - [Add ACL rules for a cluster](#add-acl-rules-for-a-cluster) - - [Delete an ACL rule for a cluster](#delete-an-acl-rule-for-a-cluster) - - [Get an ACL rule](#get-an-acl-rule) - - [Set ACL rules for a cluster](#set-acl-rules-for-a-cluster) - - [Update an ACL rule for a Redis™ Database Instance (network rule)](#update-an-acl-rule-for-a-redis™-database-instance-(network-rule)) -- [Cluster management commands](#cluster-management-commands) - - [Connect to a Redis cluster using locally installed redis-cli](#connect-to-a-redis-cluster-using-locally-installed-redis-cli) - - [Create a Redis™ Database Instance](#create-a-redis™-database-instance) - - [Delete a Redis™ Database Instance](#delete-a-redis™-database-instance) - - [Get a Redis™ Database Instance](#get-a-redis™-database-instance) - - [Get the TLS certificate of a cluster](#get-the-tls-certificate-of-a-cluster) - - [List Redis™ Database Instances](#list-redis™-database-instances) - - [Get metrics of a Redis™ Database Instance](#get-metrics-of-a-redis™-database-instance) - - [Scale up a Redis™ Database Instance](#scale-up-a-redis™-database-instance) - - [Renew the TLS certificate of a cluster](#renew-the-tls-certificate-of-a-cluster) - - [Update a Redis™ Database Instance](#update-a-redis™-database-instance) - - [Wait for a Redis cluster to reach a stable state](#wait-for-a-redis-cluster-to-reach-a-stable-state) -- [Endpoints management commands](#endpoints-management-commands) - - [Add endpoints for a cluster](#add-endpoints-for-a-cluster) - - [Delete an endpoint for a cluster](#delete-an-endpoint-for-a-cluster) - - [Get an endpoint](#get-an-endpoint) - - [Set endpoints for a cluster](#set-endpoints-for-a-cluster) - - [Update an endpoint](#update-an-endpoint) -- [Node Types management commands](#node-types-management-commands) - - [List available node types](#list-available-node-types) -- [Settings management commands](#settings-management-commands) - - [Add advanced settings](#add-advanced-settings) - - [Delete advanced setting](#delete-advanced-setting) - - [Set advanced settings](#set-advanced-settings) -- [Redis™ version management commands](#redis™-version-management-commands) - - [List available Redis™ versions](#list-available-redis™-versions) - - [List available settings from a Redis™ version](#list-available-settings-from-a-redis™-version) - - ## Access Control List (ACL) management commands Network Access Control Lists (ACLs) allow you to manage network inbound traffic by setting up ACL rules. diff --git a/docs/commands/registry.md b/docs/commands/registry.md index ca42de2f3c..850780e35f 100644 --- a/docs/commands/registry.md +++ b/docs/commands/registry.md @@ -2,26 +2,6 @@ # Documentation for `scw registry` This API allows you to manage your Container Registry resources. -- [Image management commands](#image-management-commands) - - [Delete an image](#delete-an-image) - - [Get an image](#get-an-image) - - [List images](#list-images) - - [Update an image](#update-an-image) -- [Install a local Docker credential helper](#install-a-local-docker-credential-helper) -- [Login to a registry](#login-to-a-registry) -- [Logout of a registry](#logout-of-a-registry) -- [Namespace management commands](#namespace-management-commands) - - [Create a namespace](#create-a-namespace) - - [Delete a namespace](#delete-a-namespace) - - [Get a namespace](#get-a-namespace) - - [List namespaces](#list-namespaces) - - [Update a namespace](#update-a-namespace) -- [Tag management commands](#tag-management-commands) - - [Delete a tag](#delete-a-tag) - - [Get a tag](#get-a-tag) - - [List tags](#list-tags) - - ## Image management commands An image represents a container image. A container image is a file that includes all the requirements and instructions of a complete and executable version of an application. When running, it becomes one or multiple instances of that application. diff --git a/docs/commands/s2s-vpn.md b/docs/commands/s2s-vpn.md index d16217ff17..e71621adb5 100644 --- a/docs/commands/s2s-vpn.md +++ b/docs/commands/s2s-vpn.md @@ -2,39 +2,6 @@ # Documentation for `scw s2s-vpn` This API allows you to manage your Site-to-Site VPN. -- [A connection represents the IPsec tunnel between VPN gateway and customer gateway.](#a-connection-represents-the-ipsec-tunnel-between-vpn-gateway-and-customer-gateway.) - - [Create a connection](#create-a-connection) - - [Delete a connection](#delete-a-connection) - - [Detach a routing policy](#detach-a-routing-policy) - - [Disable route propagation](#disable-route-propagation) - - [Enable route propagation](#enable-route-propagation) - - [Get a connection](#get-a-connection) - - [List connections](#list-connections) - - [Renew pre-shared key](#renew-pre-shared-key) - - [Set a new routing policy](#set-a-new-routing-policy) - - [Update a connection](#update-a-connection) -- [A customer gateway represents a Scaleway client's device that communicates with a VPN gateway.](#a-customer-gateway-represents-a-scaleway-client's-device-that-communicates-with-a-vpn-gateway.) - - [Create a customer gateway](#create-a-customer-gateway) - - [Delete a customer gateway](#delete-a-customer-gateway) - - [Get a customer gateway](#get-a-customer-gateway) - - [List customer gateways](#list-customer-gateways) - - [Update a customer gateway](#update-a-customer-gateway) -- [By default, all routes across the Site-to-Site VPN (between VPN gateway and customer gateway) are blocked. Routing policies allow you to set filters to define the IP prefixes to allow.](#by-default,-all-routes-across-the-site-to-site-vpn-(between-vpn-gateway-and-customer-gateway)-are-blocked.-routing-policies-allow-you-to-set-filters-to-define-the-ip-prefixes-to-allow.) - - [Create a routing policy](#create-a-routing-policy) - - [Delete a routing policy](#delete-a-routing-policy) - - [Get routing policy](#get-routing-policy) - - [List routing policies](#list-routing-policies) - - [Update a routing policy](#update-a-routing-policy) -- [A VPN gateway is an IPsec peer managed by Scaleway. It can support multiple connections to customer gateways.](#a-vpn-gateway-is-an-ipsec-peer-managed-by-scaleway.-it-can-support-multiple-connections-to-customer-gateways.) - - [Create VPN gateway](#create-vpn-gateway) - - [Delete a VPN gateway](#delete-a-vpn-gateway) - - [Get a VPN gateway](#get-a-vpn-gateway) - - [List VPN gateways](#list-vpn-gateways) - - [Update a VPN gateway](#update-a-vpn-gateway) -- [VPN gateways come in various shapes, sizes and prices, which are described by VPN gateway types. They represent the different commercial offer types for VPN gateways available at Scaleway.](#vpn-gateways-come-in-various-shapes,-sizes-and-prices,-which-are--described-by-vpn-gateway-types.-they-represent-the-different-commercial--offer-types-for-vpn-gateways-available-at-scaleway.) - - [List VPN gateway types](#list-vpn-gateway-types) - - ## A connection represents the IPsec tunnel between VPN gateway and customer gateway. A connection represents the IPsec tunnel between VPN gateway and customer gateway. diff --git a/docs/commands/sdb-sql.md b/docs/commands/sdb-sql.md index 3c93cccc90..6afca295f5 100644 --- a/docs/commands/sdb-sql.md +++ b/docs/commands/sdb-sql.md @@ -2,19 +2,6 @@ # Documentation for `scw sdb-sql` This API allows you to manage your Serverless SQL Databases. -- [](#) - - [Export a database backup](#export-a-database-backup) - - [Get a database backup information](#get-a-database-backup-information) - - [List your Serverless SQL Database backups](#list-your-serverless-sql-database-backups) -- [](#) - - [Create a new Serverless SQL Database](#create-a-new-serverless-sql-database) - - [Delete a database](#delete-a-database) - - [Get a database information](#get-a-database-information) - - [List your Serverless SQL Databases](#list-your-serverless-sql-databases) - - [Restore a database from a backup](#restore-a-database-from-a-backup) - - [Update database information](#update-database-information) - - ## diff --git a/docs/commands/search.md b/docs/commands/search.md index a16cc64b3a..3ba69f7385 100644 --- a/docs/commands/search.md +++ b/docs/commands/search.md @@ -2,10 +2,6 @@ # Documentation for `scw search` Search API -- [Resource search commands](#resource-search-commands) - - [Search API](#search-api) - - ## Resource search commands Resource search commands. diff --git a/docs/commands/searchdb.md b/docs/commands/searchdb.md index 5c3186c962..417eeab526 100644 --- a/docs/commands/searchdb.md +++ b/docs/commands/searchdb.md @@ -2,27 +2,6 @@ # Documentation for `scw searchdb` Cloud Essentials for Opensearch API. -- [](#) - - [Create a new Cloud Essentials for OpenSearch deployment](#create-a-new-cloud-essentials-for-opensearch-deployment) - - [Delete a Cloud Essentials for OpenSearch deployment](#delete-a-cloud-essentials-for-opensearch-deployment) - - [Retrieve a specific Cloud Essentials for OpenSearch deployment](#retrieve-a-specific-cloud-essentials-for-opensearch-deployment) - - [Retrieve a list of Cloud Essentials for OpenSearch deployments](#retrieve-a-list-of-cloud-essentials-for-opensearch-deployments) - - [Update a Cloud Essentials for OpenSearch deployment](#update-a-cloud-essentials-for-opensearch-deployment) - - [Upgrade a Cloud Essentials for OpenSearch deployment](#upgrade-a-cloud-essentials-for-opensearch-deployment) -- [](#) - - [Create a new endpoint on a deployment](#create-a-new-endpoint-on-a-deployment) - - [Delete an existing endpoint](#delete-an-existing-endpoint) -- [](#) - - [Retrieve a list of available node types](#retrieve-a-list-of-available-node-types) -- [](#) - - [Create a new user](#create-a-new-user) - - [Delete an existing user](#delete-an-existing-user) - - [Retrieve a list of deployment users](#retrieve-a-list-of-deployment-users) - - [Update an existing user](#update-an-existing-user) -- [](#) - - [List available Cloud Essentials for OpenSearch versions](#list-available-cloud-essentials-for-opensearch-versions) - - ## Manage your Cloud Essentials for OpenSearch deployment. diff --git a/docs/commands/secret.md b/docs/commands/secret.md index d5aca7026b..6de22a9381 100644 --- a/docs/commands/secret.md +++ b/docs/commands/secret.md @@ -2,27 +2,6 @@ # Documentation for `scw secret` This API allows you to manage your Secret Manager services, for storing, accessing and sharing sensitive data such as passwords, API keys and certificates. -- [Secret management commands](#secret-management-commands) - - [Allow a product to use the secret](#allow-a-product-to-use-the-secret) - - [Create a secret](#create-a-secret) - - [Delete a secret](#delete-a-secret) - - [Get metadata using the secret's ID](#get-metadata-using-the-secret's-id) - - [List secrets](#list-secrets) - - [Enable secret protection](#enable-secret-protection) - - [Disable secret protection](#disable-secret-protection) - - [Update metadata of a secret](#update-metadata-of-a-secret) -- [Secret Version management commands](#secret-version-management-commands) - - [Access a secret's version using the secret's ID](#access-a-secret's-version-using-the-secret's-id) - - [Access a secret's version using the secret's name and path](#access-a-secret's-version-using-the-secret's-name-and-path) - - [Create a version](#create-a-version) - - [Delete a version](#delete-a-version) - - [Disable a version](#disable-a-version) - - [Enable a version](#enable-a-version) - - [Get metadata of a secret's version using the secret's ID](#get-metadata-of-a-secret's-version-using-the-secret's-id) - - [List versions of a secret using the secret's ID](#list-versions-of-a-secret-using-the-secret's-id) - - [Update metadata of a version](#update-metadata-of-a-version) - - ## Secret management commands Secrets are logical containers made up of zero or more immutable versions, that contain sensitive data. diff --git a/docs/commands/shell.md b/docs/commands/shell.md index 2c9928fdfd..15b4410752 100644 --- a/docs/commands/shell.md +++ b/docs/commands/shell.md @@ -2,5 +2,3 @@ # Documentation for `scw shell` Start shell mode - - diff --git a/docs/commands/tem.md b/docs/commands/tem.md index df767f3553..dd6c9d2704 100644 --- a/docs/commands/tem.md +++ b/docs/commands/tem.md @@ -2,39 +2,6 @@ # Documentation for `scw tem` This API allows you to manage your Transactional Email services. -- [Blocklist](#blocklist) - - [Bulk create blocklists](#bulk-create-blocklists) - - [Delete a blocklist](#delete-a-blocklist) - - [List blocklists](#list-blocklists) -- [Domain management commands](#domain-management-commands) - - [Domain DNS check](#domain-dns-check) - - [Register a domain in a project](#register-a-domain-in-a-project) - - [Get information about a domain](#get-information-about-a-domain) - - [Display SPF, DKIM, DMARC and MX records status and potential errors](#display-spf,-dkim,-dmarc-and-mx-records-status-and-potential-errors) - - [List domains](#list-domains) - - [Delete a domain](#delete-a-domain) - - [Update a domain](#update-a-domain) -- [Email management commands](#email-management-commands) - - [Cancel an email](#cancel-an-email) - - [Send an email](#send-an-email) - - [Get an email](#get-an-email) - - [Email statuses](#email-statuses) - - [List emails](#list-emails) -- [Project offers management commands](#project-offers-management-commands) - - [List the available offers.](#list-the-available-offers.) - - [Update a subscribed offer](#update-a-subscribed-offer) -- [Project consumption management commands](#project-consumption-management-commands) - - [Get project resource consumption.](#get-project-resource-consumption.) -- [Project settings management commands](#project-settings-management-commands) -- [Webhook management commands](#webhook-management-commands) - - [Create a Webhook](#create-a-webhook) - - [Delete a Webhook](#delete-a-webhook) - - [Get information about a Webhook](#get-information-about-a-webhook) - - [List Webhooks](#list-webhooks) - - [List Webhook triggered events](#list-webhook-triggered-events) - - [Update a Webhook](#update-a-webhook) - - ## Blocklist This section allows you to manage the blocklist of your emails. diff --git a/docs/commands/version.md b/docs/commands/version.md index 7004de8e4e..5bd1f5f7cd 100644 --- a/docs/commands/version.md +++ b/docs/commands/version.md @@ -2,5 +2,3 @@ # Documentation for `scw version` Display cli version - - diff --git a/docs/commands/vpc-gw.md b/docs/commands/vpc-gw.md index 6a919b2d54..cafadd1ed9 100644 --- a/docs/commands/vpc-gw.md +++ b/docs/commands/vpc-gw.md @@ -2,38 +2,6 @@ # Documentation for `scw vpc-gw` This API allows you to manage your Public Gateways. -- [Public Gateway management](#public-gateway-management) - - [Create a Public Gateway](#create-a-public-gateway) - - [Delete a Public Gateway](#delete-a-public-gateway) - - [Get a Public Gateway](#get-a-public-gateway) - - [List Public Gateways](#list-public-gateways) - - [Refresh a Public Gateway's SSH keys](#refresh-a-public-gateway's-ssh-keys) - - [Update a Public Gateway](#update-a-public-gateway) - - [Upgrade a Public Gateway to the latest version and/or to a different commercial offer type](#upgrade-a-public-gateway-to-the-latest-version-andor-to-a-different-commercial-offer-type) -- [Gateway Networks management](#gateway-networks-management) - - [Attach a Public Gateway to a Private Network](#attach-a-public-gateway-to-a-private-network) - - [Detach a Public Gateway from a Private Network](#detach-a-public-gateway-from-a-private-network) - - [Get a Public Gateway connection to a Private Network](#get-a-public-gateway-connection-to-a-private-network) - - [List Public Gateway connections to Private Networks](#list-public-gateway-connections-to-private-networks) - - [Update a Public Gateway's connection to a Private Network](#update-a-public-gateway's-connection-to-a-private-network) -- [Gateway types information](#gateway-types-information) - - [List Public Gateway types](#list-public-gateway-types) -- [IP address management](#ip-address-management) - - [Reserve an IP](#reserve-an-ip) - - [Delete an IP](#delete-an-ip) - - [Get an IP](#get-an-ip) - - [List IPs](#list-ips) - - [Update an IP](#update-an-ip) -- [PAT rules management](#pat-rules-management) - - [Create a PAT rule](#create-a-pat-rule) - - [Delete a PAT rule](#delete-a-pat-rule) - - [Edit all PAT rules of a Public Gateway](#edit-all-pat-rules-of-a-public-gateway) - - [Get a PAT rule](#get-a-pat-rule) - - [List PAT rules](#list-pat-rules) - - [Set all PAT rules](#set-all-pat-rules) - - [Update a PAT rule](#update-a-pat-rule) - - ## Public Gateway management Public Gateways are building blocks for your infrastructure on Scaleway's shared public cloud. They provide a set of managed network services and features for Scaleway's Private Networks such NAT and PAT rules. diff --git a/docs/commands/vpc.md b/docs/commands/vpc.md index 244040e1c6..0c843ade90 100644 --- a/docs/commands/vpc.md +++ b/docs/commands/vpc.md @@ -2,44 +2,6 @@ # Documentation for `scw vpc` This API allows you to manage your Virtual Private Clouds (VPCs) and Private Networks. -- [Ingress rule management command](#ingress-rule-management-command) - - [Create an ingress rule](#create-an-ingress-rule) - - [Delete an ingress rule](#delete-an-ingress-rule) - - [Get an ingress rule](#get-an-ingress-rule) - - [List ingress rules](#list-ingress-rules) - - [Update an ingress rule](#update-an-ingress-rule) -- [Private network management command](#private-network-management-command) - - [Create a Private Network](#create-a-private-network) - - [Delete a Private Network](#delete-a-private-network) - - [Enable DHCP on a Private Network](#enable-dhcp-on-a-private-network) - - [Get a Private Network](#get-a-private-network) - - [List Private Networks](#list-private-networks) - - [Update Private Network](#update-private-network) -- [Route management command](#route-management-command) - - [Create a Route](#create-a-route) - - [Delete a Route](#delete-a-route) - - [Enable routing on a VPC](#enable-routing-on-a-vpc) - - [Get a Route](#get-a-route) - - [Return routes with associated next hop data](#return-routes-with-associated-next-hop-data) - - [Update Route](#update-route) -- [Rule management command](#rule-management-command) - - [Edit all ACL rules of a VPC](#edit-all-acl-rules-of-a-vpc) - - [Get ACL Rules for VPC](#get-acl-rules-for-vpc) - - [Set VPC ACL rules](#set-vpc-acl-rules) -- [VPC management command](#vpc-management-command) - - [Create a VPC](#create-a-vpc) - - [Delete a VPC](#delete-a-vpc) - - [Get a VPC](#get-a-vpc) - - [List VPCs](#list-vpcs) - - [Update VPC](#update-vpc) -- [VPC connector management command](#vpc-connector-management-command) - - [Create a VPC connector](#create-a-vpc-connector) - - [Delete a VPC connector](#delete-a-vpc-connector) - - [Get a VPC connector](#get-a-vpc-connector) - - [List VPC connectors](#list-vpc-connectors) - - [Update VPC connector](#update-vpc-connector) - - ## Ingress rule management command Ingress rules. diff --git a/docs/commands/webhosting.md b/docs/commands/webhosting.md index 787b9cdf83..57af3dd477 100644 --- a/docs/commands/webhosting.md +++ b/docs/commands/webhosting.md @@ -2,64 +2,6 @@ # Documentation for `scw webhosting` This API allows you to list and restore backups for your cPanel and WordPress Web Hosting service. -- [Backups](#backups) - - [Get info about a backup specified by the backup ID.](#get-info-about-a-backup-specified-by-the-backup-id.) - - [List all available backups for a hosting account.](#list-all-available-backups-for-a-hosting-account.) - - [Restore an entire backup to your hosting environment.](#restore-an-entire-backup-to-your-hosting-environment.) -- [Backups items](#backups-items) - - [List items within a specific backup, grouped by type.](#list-items-within-a-specific-backup,-grouped-by-type.) - - [Restore specific items from a backup (e.g., a database or mailbox).](#restore-specific-items-from-a-backup-(e.g.,-a-database-or-mailbox).) -- [Control Panels](#control-panels) - - ["List the control panels type: cpanel or plesk."](#"list-the-control-panels-type:-cpanel-or-plesk.") -- [Database](#database) - - ["Create a new database within your hosting plan"](#"create-a-new-database-within-your-hosting-plan") - - ["Delete a database within your hosting plan"](#"delete-a-database-within-your-hosting-plan") - - ["Get details of a database within your hosting plan"](#"get-details-of-a-database-within-your-hosting-plan") - - ["List all databases within your hosting plan"](#"list-all-databases-within-your-hosting-plan") -- [Database User](#database-user) - - ["Assign a database user to a database"](#"assign-a-database-user-to-a-database") - - ["Change the password of a database user"](#"change-the-password-of-a-database-user") - - ["Create a new database user"](#"create-a-new-database-user") - - ["Delete a database user"](#"delete-a-database-user") - - ["Get details of a database user"](#"get-details-of-a-database-user") - - ["List all database users"](#"list-all-database-users") - - ["Unassign a database user from a database"](#"unassign-a-database-user-from-a-database") -- [Domain information commands](#domain-information-commands) - - [Get DNS records](#get-dns-records) -- [Domain information commands](#domain-information-commands) - - [Check whether you own this domain or not.](#check-whether-you-own-this-domain-or-not.) - - [Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.](#retrieve-detailed-information-about-a-specific-domain,-including-its-status,-dns-configuration,-and-ownership.) - - [Synchronize your DNS records on the Elements Console and on cPanel.](#synchronize-your-dns-records-on-the-elements-console-and-on-cpanel.) -- [Domain information commands](#domain-information-commands) - - [Search for available domains based on domain name.](#search-for-available-domains-based-on-domain-name.) -- [Free domains](#free-domains) - - [Check whether a given slug and free domain combination is available.](#check-whether-a-given-slug-and-free-domain-combination-is-available.) - - [Retrieve the list of free root domains available for a Web Hosting.](#retrieve-the-list-of-free-root-domains-available-for-a-web-hosting.) -- [FTP Account](#ftp-account) - - [Create a new FTP account within your hosting plan.](#create-a-new-ftp-account-within-your-hosting-plan.) - - [Delete a specific FTP account within your hosting plan.](#delete-a-specific-ftp-account-within-your-hosting-plan.) - - [List all FTP accounts within your hosting plan.](#list-all-ftp-accounts-within-your-hosting-plan.) -- [Hosting management commands](#hosting-management-commands) - - [Order a Web Hosting plan](#order-a-web-hosting-plan) - - [Create a user session](#create-a-user-session) - - [Delete a Web Hosting plan](#delete-a-web-hosting-plan) - - [Get a Web Hosting plan](#get-a-web-hosting-plan) - - [List all Web Hosting plans](#list-all-web-hosting-plans) - - [Update a Web Hosting plan](#update-a-web-hosting-plan) -- [Mail Account](#mail-account) - - [Update the password of a mail account within your hosting plan.](#update-the-password-of-a-mail-account-within-your-hosting-plan.) - - [Create a new mail account within your hosting plan.](#create-a-new-mail-account-within-your-hosting-plan.) - - [Delete a mail account within your hosting plan.](#delete-a-mail-account-within-your-hosting-plan.) - - [List all mail accounts within your hosting plan.](#list-all-mail-accounts-within-your-hosting-plan.) -- [Offer](#offer) - - [List all available hosting offers along with their specific options.](#list-all-available-hosting-offers-along-with-their-specific-options.) -- [Progresses](#progresses) - - [Retrieve detailed information about a specific progress by its ID.](#retrieve-detailed-information-about-a-specific-progress-by-its-id.) - - [List recent progresses associated with a specific backup, grouped by type.](#list-recent-progresses-associated-with-a-specific-backup,-grouped-by-type.) -- [Website](#website) - - [List all websites for a specific hosting.](#list-all-websites-for-a-specific-hosting.) - - ## Backups Backups represent snapshots of your hosting environment. diff --git a/internal/docgen/main.md.tmpl b/internal/docgen/main.md.tmpl index 784f262bd7..4ba61451ca 100644 --- a/internal/docgen/main.md.tmpl +++ b/internal/docgen/main.md.tmpl @@ -3,13 +3,6 @@ # Documentation for {{ bq }}scw {{ .Cmd.Namespace }}{{ bq }} {{ remove_escape_sequence (.Cmd.Long | default .Cmd.Short) }} -{{ range $resourceName, $resource := .Resources -}} -- [{{ $resource.Cmd.Short }}](#{{ anchor $resource.Cmd.Short }}) -{{- range $verbName, $cmd := $resource.Verbs }} - - [{{ $cmd.Short }}](#{{ anchor $cmd.Short }}) -{{- end }} -{{ end }} - {{ range $resourceName, $resource := .Resources -}} ## {{ $resource.Cmd.Short }}