Skip to content

Commit c066c62

Browse files
committed
Add clarifying details for UIDs, update examples
1 parent f439926 commit c066c62

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

docs/content/installation/integrations/app-protect-waf/compile-waf-policies.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,13 @@ You should receive an API response similar to the following output, indicating t
7777
}
7878
```
7979

80-
**Take note of the *uid* field**, which will be used to download the bundle later.
80+
{{< important >}}
81+
82+
Take note of the *uid* field.
83+
84+
It is one of two unique IDs we will use to download the bundle: it will be referenced as *policy-UID*.
85+
86+
{{< /important >}}
8187

8288
## Create a new security bundle
8389

@@ -105,6 +111,8 @@ Create the file `security-policy-bundles.json`:
105111
}
106112
```
107113

114+
The *policyUID* value is left blank, as it is generated as part of the creating the bundle.
115+
108116
Send a POST request to create the bundle through the API:
109117

110118
```shell
@@ -168,15 +176,25 @@ curl --location 'https://127.0.0.1/api/platform/v1/security/policies/bundles' \
168176
]
169177
}
170178
```
171-
Take note of the `uid` field. this is the UID for the security bundle which is required when download our bundle once it is compiled.
179+
180+
{{< important >}}
181+
182+
Take note of the *uid* field.
183+
184+
It is one of two unique IDs we will use to download the bundle: it will be referenced as *bundle-UID*.
185+
186+
{{< /important >}}
172187

173188
## Download the security bundle
174189

190+
Use a GET request to download the security bundle using the policy and bundle IDs:
191+
175192
```shell
176-
curl -X GET "https://{NMS_FQDN}/api/platform/v1/security/policies/{security-policy-uid}/bundles/{security-policy-bundle-uid}" -H "Authorization: Bearer xxxxx.yyyyy.zzzzz" | jq -r '.content' | base64 -d > security-policy-bundle.tgz
193+
curl -X GET "https://{NMS_FQDN}/api/platform/v1/security/policies/<policy-UID>/bundles/<bundle-UID>" -H "Authorization: Bearer <access token>" | jq -r '.content' | base64 -d > security-policy-bundle.tgz
177194
```
178195

179-
In our example, we are using the `seucrity-policy-id` and the `security-policy-bundle-id`
196+
This GET request uses the policy and bundle IDs from the previous examples:
197+
180198
```shell
181199
curl -X GET -k 'https://127.0.0.1/api/platform/v1/security/policies/6af9f261-658b-4be1-b07a-cebd83e917a1/bundles/de08b324-99d8-4155-b2eb-fe687b21034e' \
182200
-H "Authorization: Basic YWRtaW46UncxQXBQS3lRRTRuQXRXOFRYa1J4ZFdVSWVTSGtU" \

0 commit comments

Comments
 (0)