Skip to content
Draft
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
1 change: 1 addition & 0 deletions docs/stackit_beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ stackit beta [flags]

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit beta alb](./stackit_beta_alb.md) - Manages application loadbalancers
* [stackit beta alb-waf](./stackit_beta_alb-waf.md) - Provides functionality for Application Load Balancer Web Application Firwall
* [stackit beta cdn](./stackit_beta_cdn.md) - Manage CDN resources
* [stackit beta edge-cloud](./stackit_beta_edge-cloud.md) - Provides functionality for Edge Cloud services.
* [stackit beta intake](./stackit_beta_intake.md) - Provides functionality for intake
Expand Down
34 changes: 34 additions & 0 deletions docs/stackit_beta_alb-waf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit beta alb-waf

Provides functionality for Application Load Balancer Web Application Firwall

### Synopsis

Provides functionality for Application Load Balancer Web Application Firwall.

```
stackit beta alb-waf [flags]
```

### Options

```
-h, --help Help for "stackit beta alb-waf"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
* [stackit beta alb-waf custom-rule-group](./stackit_beta_alb-waf_custom-rule-group.md) - Provides functionality for alb-waf Custom Rule Group

39 changes: 39 additions & 0 deletions docs/stackit_beta_alb-waf_custom-rule-group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## stackit beta alb-waf custom-rule-group

Provides functionality for alb-waf Custom Rule Group

### Synopsis

Provides functionality for alb-waf Custom Rule Group.

```
stackit beta alb-waf custom-rule-group [flags]
```

### Options

```
-h, --help Help for "stackit beta alb-waf custom-rule-group"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta alb-waf](./stackit_beta_alb-waf.md) - Provides functionality for Application Load Balancer Web Application Firwall
* [stackit beta alb-waf custom-rule-group create](./stackit_beta_alb-waf_custom-rule-group_create.md) - Creates an ALB WAF custom rule group
* [stackit beta alb-waf custom-rule-group delete](./stackit_beta_alb-waf_custom-rule-group_delete.md) - Deletes an ALB WAF custom rule group
* [stackit beta alb-waf custom-rule-group describe](./stackit_beta_alb-waf_custom-rule-group_describe.md) - Shows details of an ALB WAF custom rule group
* [stackit beta alb-waf custom-rule-group generate-payload](./stackit_beta_alb-waf_custom-rule-group_generate-payload.md) - Generates a payload to create/update an ALB WAF custom rule group
* [stackit beta alb-waf custom-rule-group list](./stackit_beta_alb-waf_custom-rule-group_list.md) - Lists all ALB WAF custom rule groups
* [stackit beta alb-waf custom-rule-group update](./stackit_beta_alb-waf_custom-rule-group_update.md) - Updates an ALB WAF custom rule group

46 changes: 46 additions & 0 deletions docs/stackit_beta_alb-waf_custom-rule-group_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## stackit beta alb-waf custom-rule-group create

Creates an ALB WAF custom rule group

### Synopsis

Creates a STACKIT Application Load Balancer (ALB) Web Application Firewall (WAF) custom rule group.
The payload can be provided as a JSON string or a file path prefixed with "@".
See https://docs.api.stackit.cloud/documentation/alb-waf/version/v1 for information regarding the payload structure.

```
stackit beta alb-waf custom-rule-group create [flags]
```

### Examples

```
Create an ALB WAF custom rule group using an API payload sourced from the file "./payload.json"
$ stackit beta alb-waf custom-rule-group create --payload @./payload.json

Create an ALB WAF custom rule group using an API payload provided as a JSON string
$ stackit beta alb-waf custom-rule-group create --payload "{...}"
```

### Options

```
-h, --help Help for "stackit beta alb-waf custom-rule-group create"
--payload string Request payload (JSON). Can be a string or a file path, if prefixed with "@" (example: @./payload.json).
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta alb-waf custom-rule-group](./stackit_beta_alb-waf_custom-rule-group.md) - Provides functionality for alb-waf Custom Rule Group

41 changes: 41 additions & 0 deletions docs/stackit_beta_alb-waf_custom-rule-group_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## stackit beta alb-waf custom-rule-group delete

Deletes an ALB WAF custom rule group

### Synopsis

Deletes a STACKIT Application Load Balancer (ALB) Web Application Firewall (WAF) custom rule group.
A custom rule group can only be deleted if it is not referenced by any WAF configuration.

```
stackit beta alb-waf custom-rule-group delete CUSTOM_RULE_GROUP_NAME [flags]
```

### Examples

```
Delete an ALB WAF custom rule group with name "my-custom-rule-group"
$ stackit beta alb-waf custom-rule-group delete my-custom-rule-group
```

### Options

```
-h, --help Help for "stackit beta alb-waf custom-rule-group delete"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta alb-waf custom-rule-group](./stackit_beta_alb-waf_custom-rule-group.md) - Provides functionality for alb-waf Custom Rule Group

40 changes: 40 additions & 0 deletions docs/stackit_beta_alb-waf_custom-rule-group_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit beta alb-waf custom-rule-group describe

Shows details of an ALB WAF custom rule group

### Synopsis

Shows details of a STACKIT Application Load Balancer (ALB) Web Application Firewall (WAF) custom rule group.

```
stackit beta alb-waf custom-rule-group describe CUSTOM_RULE_GROUP_NAME [flags]
```

### Examples

```
Show details of an ALB WAF custom rule group with name "my-custom-rule-group"
$ stackit beta alb-waf custom-rule-group describe my-custom-rule-group
```

### Options

```
-h, --help Help for "stackit beta alb-waf custom-rule-group describe"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta alb-waf custom-rule-group](./stackit_beta_alb-waf_custom-rule-group.md) - Provides functionality for alb-waf Custom Rule Group

54 changes: 54 additions & 0 deletions docs/stackit_beta_alb-waf_custom-rule-group_generate-payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## stackit beta alb-waf custom-rule-group generate-payload

Generates a payload to create/update an ALB WAF custom rule group

### Synopsis

Generates a JSON payload with values to be used as --payload input for ALB WAF custom rule group creation or update.
If --name is set, the payload is generated with the current values of the given custom rule group, to be used with the update command. If unset, a payload with default values for the create command is generated.
See https://docs.api.stackit.cloud/documentation/alb-waf/version/v1 for information regarding the payload structure.

```
stackit beta alb-waf custom-rule-group generate-payload [flags]
```

### Examples

```
Generate a payload with default values, and adapt it with custom values for the different configuration options
$ stackit beta alb-waf custom-rule-group generate-payload --file-path ./payload.json
<Modify payload in file, if needed>
$ stackit beta alb-waf custom-rule-group create --payload @./payload.json

Generate a payload with the current values of an existing custom rule group, and adapt it with custom values for the different configuration options
$ stackit beta alb-waf custom-rule-group generate-payload --name my-custom-rule-group --file-path ./payload.json
<Modify payload in file>
$ stackit beta alb-waf custom-rule-group update my-custom-rule-group --payload @./payload.json

Generate a payload with the current values of an existing custom rule group, and preview it in the terminal
$ stackit beta alb-waf custom-rule-group generate-payload --name my-custom-rule-group
```

### Options

```
-f, --file-path string If set, writes the payload to the given file. If unset, writes the payload to the standard output
-h, --help Help for "stackit beta alb-waf custom-rule-group generate-payload"
-n, --name string If set, generates the payload with the current values of the given custom rule group (to be used with the update command). If unset, generates the payload with default values (to be used with the create command)
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta alb-waf custom-rule-group](./stackit_beta_alb-waf_custom-rule-group.md) - Provides functionality for alb-waf Custom Rule Group

44 changes: 44 additions & 0 deletions docs/stackit_beta_alb-waf_custom-rule-group_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## stackit beta alb-waf custom-rule-group list

Lists all ALB WAF custom rule groups

### Synopsis

Lists all STACKIT Application Load Balancer (ALB) Web Application Firewall (WAF) custom rule groups.

```
stackit beta alb-waf custom-rule-group list [flags]
```

### Examples

```
List all ALB WAF custom rule groups
$ stackit beta alb-waf custom-rule-group list

List the first 10 ALB WAF custom rule groups
$ stackit beta alb-waf custom-rule-group list --limit=10
```

### Options

```
-h, --help Help for "stackit beta alb-waf custom-rule-group list"
--limit int Limit the output to the first n elements
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta alb-waf custom-rule-group](./stackit_beta_alb-waf_custom-rule-group.md) - Provides functionality for alb-waf Custom Rule Group

52 changes: 52 additions & 0 deletions docs/stackit_beta_alb-waf_custom-rule-group_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
## stackit beta alb-waf custom-rule-group update

Updates an ALB WAF custom rule group

### Synopsis

Updates a STACKIT Application Load Balancer (ALB) Web Application Firewall (WAF) custom rule group.
The rules of the custom rule group are replaced atomically: send the complete desired rule set, per-rule partial merge is not supported.
The payload can be provided as a JSON string or a file path prefixed with "@". The rule IDs and the rule behavior severity are managed by the server and cannot be set.
See https://docs.api.stackit.cloud/documentation/alb-waf/version/v1 for information regarding the payload structure.

```
stackit beta alb-waf custom-rule-group update CUSTOM_RULE_GROUP_NAME [flags]
```

### Examples

```
Update an ALB WAF custom rule group using an API payload sourced from the file "./payload.json"
$ stackit beta alb-waf custom-rule-group update my-custom-rule-group --payload @./payload.json

Update an ALB WAF custom rule group using an API payload provided as a JSON string
$ stackit beta alb-waf custom-rule-group update my-custom-rule-group --payload "{...}"

Generate a payload with the current values of an existing custom rule group, adapt it and update the custom rule group with it
$ stackit beta alb-waf custom-rule-group generate-payload --name my-custom-rule-group > ./payload.json
<Modify payload in file>
$ stackit beta alb-waf custom-rule-group update my-custom-rule-group --payload @./payload.json
```

### Options

```
-h, --help Help for "stackit beta alb-waf custom-rule-group update"
--payload string Request payload (JSON). Can be a string or a file path, if prefixed with "@" (example: @./payload.json).
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit beta alb-waf custom-rule-group](./stackit_beta_alb-waf_custom-rule-group.md) - Provides functionality for alb-waf Custom Rule Group

1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ require (
github.com/spf13/viper v1.21.0
github.com/stackitcloud/stackit-sdk-go/core v0.26.0
github.com/stackitcloud/stackit-sdk-go/services/alb v0.14.2
github.com/stackitcloud/stackit-sdk-go/services/albwaf v0.13.1
github.com/stackitcloud/stackit-sdk-go/services/authorization v0.15.2
github.com/stackitcloud/stackit-sdk-go/services/cdn v1.16.0
github.com/stackitcloud/stackit-sdk-go/services/dns v0.21.0
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,8 @@ github.com/stackitcloud/stackit-sdk-go/core v0.26.0 h1:jQEb9gkehfp6VCP6TcYk7BI10
github.com/stackitcloud/stackit-sdk-go/core v0.26.0/go.mod h1:WU1hhxnjXw2EV7CYa1nlEvNpMiRY6CvmIOaHuL3pOaA=
github.com/stackitcloud/stackit-sdk-go/services/alb v0.14.2 h1:hGzfOJjlCRoFpri5eYIiwhE27qu02pKZLprKvbsTC/w=
github.com/stackitcloud/stackit-sdk-go/services/alb v0.14.2/go.mod h1:eK6oRB5Tmpt6KbXQ4UYBGg2LgW5bPtVoncL9E8JSRww=
github.com/stackitcloud/stackit-sdk-go/services/albwaf v0.13.1 h1:NsUOizMbRrIyvxHGLzwL6WKHs1/CWXoFV6d1wPI6YsM=
github.com/stackitcloud/stackit-sdk-go/services/albwaf v0.13.1/go.mod h1:4M9G1I64kZwlXO32ZoIpt0GAN4SpZ1SYerwCVVIBGoE=
github.com/stackitcloud/stackit-sdk-go/services/authorization v0.15.2 h1:b7WJ/vwxlVmNNX91kI3obqGcuoPAyaCbDL5aCMQ/sNg=
github.com/stackitcloud/stackit-sdk-go/services/authorization v0.15.2/go.mod h1:T/JF25XGJ3GqER/1L2N//DgY8x5tY7gA3N+/0nvmOWY=
github.com/stackitcloud/stackit-sdk-go/services/cdn v1.16.0 h1:Wqxx0PDTL2F5gqI5jjznuJY0TdqECltjA0aa/rHY63U=
Expand Down
Loading