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
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.

USAGE:
scw document-db setting set [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
[order-by] Order of the domains (created_at_asc | created_at_desc | hostname_asc | hostname_desc)
[function-id] UUID of the function the domain is assoicated with
[function-id] UUID of the function the domain is associated with
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
[name=<generated>] Name of the function to create
[namespace-id] UUID of the namespace the function will be created in
[environment-variables.{key}] Environment variables of the function
[min-scale] Minumum number of instances to scale the function to
[min-scale] Minimum number of instances to scale the function to
[max-scale] Maximum number of instances to scale the function to
[runtime] Runtime to use with the function (unknown_runtime | golang | python | python3 | node8 | node10 | node14 | node16 | node17 | python37 | python38 | python39 | python310 | go113 | go117 | go118 | node18 | rust165 | go119 | python311 | php82 | node19 | go120 | node20 | go121 | node22 | python312 | php83 | go122 | rust179 | go123 | go124 | python313 | rust185 | php84)
[memory-limit] Memory limit of the function in MB
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USAGE:
scw function function get-download-url <function-id ...> [arg=value ...]

ARGS:
function-id UUID of the function to get the the download URL for
function-id UUID of the function to get the download URL for
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ARGS:
[namespace-id] UUID of the namespace the function belongs to
[name] Name of the function
[project-id] UUID of the Project the function belongs to
[organization-id] UUID of the Organziation the function belongs to
[organization-id] UUID of the Organization the function belongs to
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)

FLAGS:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ USAGE:
ARGS:
function-id UUID of the function to update
[environment-variables.{key}] Environment variables of the function to update
[min-scale] Minumum number of instances to scale the function to
[min-scale] Minimum number of instances to scale the function to
[max-scale] Maximum number of instances to scale the function to
[runtime] Runtime to use with the function (unknown_runtime | golang | python | python3 | node8 | node10 | node14 | node16 | node17 | python37 | python38 | python39 | python310 | go113 | go117 | go118 | node18 | rust165 | go119 | python311 | php82 | node19 | go120 | node20 | go121 | node22 | python312 | php83 | go122 | rust179 | go123 | go124 | python313 | rust185 | php84)
[memory-limit] Memory limit of the function in MB
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

ARGS:
[order-by] Sort order for the tokens (created_at_asc | created_at_desc)
[function-id] UUID of the function the token is assoicated with
[function-id] UUID of the function the token is associated with
[namespace-id] UUID of the namespace the token is associated with
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
Retrieve information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.

USAGE:
scw iam api-key get <access-key ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
Retrieve information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.

USAGE:
scw iam group get <group-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete an exising ACL.
Delete an existing ACL.

USAGE:
scw inference acl delete <acl-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

AVAILABLE COMMANDS:
add Add new ACLs
delete Delete an exising ACL
delete Delete an existing ACL
list List your ACLs
set Set new ACL

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ARGS:
[volumes.{key}.organization] Organization ID of the volume
[dynamic-ip-required]
[public-ips.{index}] A list of reserved IP IDs to attach to the Instance
[protected]
[protected] True to activate server protection option
[security-group-id]
[volume-ids.{index}] Will update ALL volume IDs at once, including the root volume of the server (use volume-ids=none to detach all volumes)
[placement-group-id] Placement group ID if Instance must be part of a placement group
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (facilitated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).

USAGE:
scw interlink link create [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ARGS:
[order-by] Ordering of requested devices (name_asc | name_desc | status_asc | status_desc | hub_id_asc | hub_id_desc | created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | allow_insecure_asc | allow_insecure_desc)
[name] Name to filter for, only devices with this name will be returned
[hub-id] Hub ID to filter for, only devices attached to this Hub will be returned
[allow-insecure] Defines wheter to filter the allow_insecure flag
[allow-insecure] Defines whether to filter the allow_insecure flag
[status] Device status (enabled, disabled, etc.) (unknown | error | enabled | disabled)
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.

USAGE:
scw rdb setting set [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.

USAGE:
scw redis setting set [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ARGS:
[enable-masquerade] Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork.
[enable-dhcp] Defines whether to enable DHCP on this Private Network.
[dhcp-id] ID of an existing DHCP configuration object to use for this GatewayNetwork
[address] Static IP address in CIDR format to to use without DHCP
[address] Static IP address in CIDR format to use without DHCP
[ipam-config.push-default-route] Enabling the default route also enables masquerading
[ipam-config.ipam-ip-id] Use this IPAM-booked IP ID as the Gateway's IP in this Private Network
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ USAGE:
ARGS:
[order-by] Sort order of the returned VPCs (created_at_asc | created_at_desc | name_asc | name_desc)
[name] Name to filter for. Only VPCs with names containing this string will be returned
[tags.{index}] Tags to filter for. Only VPCs with one more more matching tags will be returned
[tags.{index}] Tags to filter for. Only VPCs with one or more matching tags will be returned
[project-id] Project ID to filter for. Only VPCs belonging to this Project will be returned
[is-default] Defines whether to filter only for VPCs which are the default one for their Project
[routing-enabled] Defines whether to filter only for VPCs which route traffic between their Private Networks
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/document-db.md
Original file line number Diff line number Diff line change
Expand Up @@ -965,7 +965,7 @@ scw document-db setting delete [arg=value ...]

### Set Database Instance advanced settings

Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.

**Usage:**

Expand Down
12 changes: 6 additions & 6 deletions docs/commands/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ scw function domain list [arg=value ...]
| Name | | Description |
|------|---|-------------|
| order-by | One of: `created_at_asc`, `created_at_desc`, `hostname_asc`, `hostname_desc` | Order of the domains |
| function-id | | UUID of the function the domain is assoicated with |
| function-id | | UUID of the function the domain is associated with |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -292,7 +292,7 @@ scw function function create [arg=value ...]
| name | Default: `<generated>` | Name of the function to create |
| namespace-id | | UUID of the namespace the function will be created in |
| environment-variables.{key} | | Environment variables of the function |
| min-scale | | Minumum number of instances to scale the function to |
| min-scale | | Minimum number of instances to scale the function to |
| max-scale | | Maximum number of instances to scale the function to |
| runtime | One of: `unknown_runtime`, `golang`, `python`, `python3`, `node8`, `node10`, `node14`, `node16`, `node17`, `python37`, `python38`, `python39`, `python310`, `go113`, `go117`, `go118`, `node18`, `rust165`, `go119`, `python311`, `php82`, `node19`, `go120`, `node20`, `go121`, `node22`, `python312`, `php83`, `go122`, `rust179`, `go123`, `go124`, `python313`, `rust185`, `php84` | Runtime to use with the function |
| memory-limit | | Memory limit of the function in MB |
Expand Down Expand Up @@ -383,7 +383,7 @@ scw function function get-download-url <function-id ...> [arg=value ...]

| Name | | Description |
|------|---|-------------|
| function-id | Required | UUID of the function to get the the download URL for |
| function-id | Required | UUID of the function to get the download URL for |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |


Expand Down Expand Up @@ -428,7 +428,7 @@ scw function function list [arg=value ...]
| namespace-id | | UUID of the namespace the function belongs to |
| name | | Name of the function |
| project-id | | UUID of the Project the function belongs to |
| organization-id | | UUID of the Organziation the function belongs to |
| organization-id | | UUID of the Organization the function belongs to |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |


Expand All @@ -450,7 +450,7 @@ scw function function update <function-id ...> [arg=value ...]
|------|---|-------------|
| function-id | Required | UUID of the function to update |
| environment-variables.{key} | | Environment variables of the function to update |
| min-scale | | Minumum number of instances to scale the function to |
| min-scale | | Minimum number of instances to scale the function to |
| max-scale | | Maximum number of instances to scale the function to |
| runtime | One of: `unknown_runtime`, `golang`, `python`, `python3`, `node8`, `node10`, `node14`, `node16`, `node17`, `python37`, `python38`, `python39`, `python310`, `go113`, `go117`, `go118`, `node18`, `rust165`, `go119`, `python311`, `php82`, `node19`, `go120`, `node20`, `go121`, `node22`, `python312`, `php83`, `go122`, `rust179`, `go123`, `go124`, `python313`, `rust185`, `php84` | Runtime to use with the function |
| memory-limit | | Memory limit of the function in MB |
Expand Down Expand Up @@ -694,7 +694,7 @@ scw function token list [arg=value ...]
| Name | | Description |
|------|---|-------------|
| order-by | One of: `created_at_asc`, `created_at_desc` | Sort order for the tokens |
| function-id | | UUID of the function the token is assoicated with |
| function-id | | UUID of the function the token is associated with |
| namespace-id | | UUID of the namespace the token is associated with |
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/iam.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ scw iam api-key delete SCW00000000000

### Get an API key

Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
Retrieve information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.

**Usage:**

Expand Down Expand Up @@ -409,7 +409,7 @@ scw iam group delete 11111111-1111-1111-1111-111111111111

### Get a group

Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
Retrieve information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.

**Usage:**

Expand Down
6 changes: 3 additions & 3 deletions docs/commands/inference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This API allows you to manage your Inference services.

- [Access Control List (ACL) management commands](#access-control-list-(acl)-management-commands)
- [Add new ACLs](#add-new-acls)
- [Delete an exising ACL](#delete-an-exising-acl)
- [Delete an existing ACL](#delete-an-existing-acl)
- [List your ACLs](#list-your-acls)
- [Set new ACL](#set-new-acl)
- [Deployment commands](#deployment-commands)
Expand Down Expand Up @@ -52,9 +52,9 @@ scw inference acl add <deployment-id ...> [arg=value ...]



### Delete an exising ACL
### Delete an existing ACL

Delete an exising ACL.
Delete an existing ACL.

**Usage:**

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2301,7 +2301,7 @@ scw instance server update <server-id ...> [arg=value ...]
| ~~routed-ip-enabled~~ | Deprecated | True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False) |
| public-ips.{index} | | A list of reserved IP IDs to attach to the Instance |
| ~~enable-ipv6~~ | Deprecated | |
| protected | | |
| protected | | True to activate server protection option |
| security-group-id | | |
| volume-ids.{index} | | Will update ALL volume IDs at once, including the root volume of the server (use volume-ids=none to detach all volumes) |
| placement-group-id | | Placement group ID if Instance must be part of a placement group |
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/interlink.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ scw interlink link attach_vpc <link-id ...> [arg=value ...]

### Create a link

Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (facilitated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).

**Usage:**

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/iot.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ scw iot device list [arg=value ...]
| order-by | One of: `name_asc`, `name_desc`, `status_asc`, `status_desc`, `hub_id_asc`, `hub_id_desc`, `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`, `allow_insecure_asc`, `allow_insecure_desc` | Ordering of requested devices |
| name | | Name to filter for, only devices with this name will be returned |
| hub-id | | Hub ID to filter for, only devices attached to this Hub will be returned |
| allow-insecure | | Defines wheter to filter the allow_insecure flag |
| allow-insecure | | Defines whether to filter the allow_insecure flag |
| status | One of: `unknown`, `error`, `enabled`, `disabled` | Device status (enabled, disabled, etc.) |
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/rdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -1400,7 +1400,7 @@ scw rdb setting delete [arg=value ...]

### Set Database Instance advanced settings

Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated.

**Usage:**

Expand Down
Loading
Loading