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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete a hosting with the given ID.

USAGE:
scw webhosting hosting delete [arg=value ...]

EXAMPLES:
Delete a Hosting with the given ID
scw webhosting hosting delete hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7

ARGS:
hosting-id Hosting ID
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
-h, --help help for delete

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
The set of DNS record of a specific domain associated to a hosting.

USAGE:
scw webhosting hosting get-dns-records [arg=value ...]

EXAMPLES:
Get DNS records associated to the given domain
scw webhosting hosting get-dns-records domain=foo.com

ARGS:
domain Domain associated to the DNS records
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
-h, --help help for get-dns-records

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Restore a hosting with the given ID.

USAGE:
scw webhosting hosting restore [arg=value ...]

EXAMPLES:
Restore a Hosting with the given ID
scw webhosting hosting restore hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7

ARGS:
hosting-id Hosting ID
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)

FLAGS:
-h, --help help for restore

GLOBAL FLAGS:
-c, --config string The path to the config file
-D, --debug Enable debug mode
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
-p, --profile string The config profile to use
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@ USAGE:
scw webhosting hosting <command>

AVAILABLE COMMANDS:
create Create a hosting
get Get a hosting
list List all hostings
update Update a hosting
create Create a hosting
delete Delete a hosting
get Get a hosting
get-dns-records Get the DNS records
list List all hostings
restore Restore a hosting
update Update a hosting

FLAGS:
-h, --help help for hosting
Expand Down
1 change: 0 additions & 1 deletion cmd/scw/testdata/test-all-usage-webhosting-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ USAGE:
scw webhosting <command>

AVAILABLE COMMANDS:
dns-record DNS record management commands
hosting Hosting management commands
offer Offer management commands

Expand Down
111 changes: 83 additions & 28 deletions docs/commands/webhosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,109 +2,134 @@
# Documentation for `scw webhosting`
Webhosting API.

- [DNS record management commands](#dns-record-management-commands)
- [Get the DNS records](#get-the-dns-records)
- [Hosting management commands](#hosting-management-commands)
- [Create a hosting](#create-a-hosting)
- [Delete a hosting](#delete-a-hosting)
- [Get a hosting](#get-a-hosting)
- [Get the DNS records](#get-the-dns-records)
- [List all hostings](#list-all-hostings)
- [Restore a hosting](#restore-a-hosting)
- [Update a hosting](#update-a-hosting)
- [Offer management commands](#offer-management-commands)
- [List all offers](#list-all-offers)


## DNS record management commands
## Hosting management commands

The set of DNS record of a specific domain associated to a hosting.
A Scaleway web hosting associated with a domain name.



### Get the DNS records
### Create a hosting

Get the DNS records of a specified domain.
Create a hosting.

**Usage:**

```
scw webhosting dns-record get [arg=value ...]
scw webhosting hosting create [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| domain | Required | Domain associated to the DNS records |
| offer-id | | ID of the selected offer for the hosting |
| project-id | | Project ID to use. If none is passed the default project ID will be used |
| email | | Contact email of the client for the hosting |
| tags.{index} | | The tags of the hosting |
| domain | | The domain name of the hosting |
| option-ids.{index} | | IDs of the selected options for the hosting |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


**Examples:**

### Delete a hosting

Delete a hosting with the given ID.

**Usage:**

Get DNS records associated to the given domain
```
scw webhosting dns-record get domain=foo.com
scw webhosting hosting delete [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| hosting-id | Required | Hosting ID |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


**Examples:**

## Hosting management commands

A Scaleway web hosting associated with a domain name.
Delete a Hosting with the given ID
```
scw webhosting hosting delete hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7
```



### Create a hosting

Create a hosting.
### Get a hosting

Get the details of a Hosting with the given ID.

**Usage:**

```
scw webhosting hosting create [arg=value ...]
scw webhosting hosting get [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| offer-id | | ID of the selected offer for the hosting |
| project-id | | Project ID to use. If none is passed the default project ID will be used |
| email | | Contact email of the client for the hosting |
| tags.{index} | | The tags of the hosting |
| domain | | The domain name of the hosting |
| option-ids.{index} | | IDs of the selected options for the hosting |
| hosting-id | Required | Hosting ID |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


**Examples:**

### Get a hosting

Get the details of a Hosting with the given ID.
Get a Hosting with the given ID
```
scw webhosting hosting get hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7
```




### Get the DNS records

The set of DNS record of a specific domain associated to a hosting.

**Usage:**

```
scw webhosting hosting get [arg=value ...]
scw webhosting hosting get-dns-records [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| hosting-id | Required | Hosting ID |
| domain | Required | Domain associated to the DNS records |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


**Examples:**


Get a Hosting with the given ID
Get DNS records associated to the given domain
```
scw webhosting hosting get hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7
scw webhosting hosting get-dns-records domain=foo.com
```


Expand Down Expand Up @@ -145,6 +170,36 @@ scw webhosting hosting list project-id=a3244331-5d32-4e36-9bf9-b60233e201c7 orga



### Restore a hosting

Restore a hosting with the given ID.

**Usage:**

```
scw webhosting hosting restore [arg=value ...]
```


**Args:**

| Name | | Description |
|------|---|-------------|
| hosting-id | Required | Hosting ID |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


**Examples:**


Restore a Hosting with the given ID
```
scw webhosting hosting restore hosting-id=a3244331-5d32-4e36-9bf9-b60233e201c7
```




### Update a hosting

Update a hosting.
Expand Down
Loading