Skip to content

Commit 7fb2521

Browse files
committed
NLB-6987: Document steps to access module versions through Dataplane API
1 parent 7ba2f28 commit 7fb2521

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

content/nginxaas-azure/module-changelog.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,43 @@ url: /nginxaas/azure/module-changelog/
88
Learn about the modules supported by the latest versions of F5 NGINXaaS for Azure.
99

1010

11+
## Access module versions using data plane API:
12+
13+
To access available module versions from the data plane API, follow these steps:
14+
- View Your API Endpoints and Create an API Key
15+
- Follow the [NGINXaaS data plane API endpoint]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#nginxaas-data-plane-api-endpoint" >}}) and [Create an NGINXaaS data plane API key]({{< ref "/nginxaas-azure/loadbalancer-kubernetes.md#create-an-nginxaas-data-plane-api-key" >}}) to locate your dataplane API endpoint and create an API key.
16+
17+
- Construct the Request URL
18+
- Add `/packages` to your data plane API endpoint, for example `https://<your-endpoint>/packages`.
19+
20+
- Authenticate API requests
21+
- Encode your API key to Base64 and add the prefix `ApiKey` to the encoded string.
22+
- Set the `Authorization` HTTP header to:
23+
`ApiKey <your_api_key>`
24+
25+
26+
```shell
27+
curl -H "Authorization: ApiKey <your_api_key>" https://<your-endpoint>/packages
28+
```
29+
30+
Response Example:
31+
```json
32+
{
33+
"packages": [
34+
{
35+
"name": "nginx-plus-module-headers-more",
36+
"version":"35+0.37-1~jammy"
37+
},
38+
{
39+
"name": "nginx-plus-module-otel",
40+
"version": "35+0.1.2-1~jammy"
41+
},
42+
...
43+
]
44+
}
45+
```
46+
47+
1148
## July 03, 2025
1249

1350
### Stable

0 commit comments

Comments
 (0)