Skip to content

Commit 32cb7fc

Browse files
committed
NLB-6987: Document steps to access module versions through Dataplane API
1 parent 9fc4b77 commit 32cb7fc

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

content/nginxaas-azure/module-changelog.md

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

1010

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

1351
### Stable

0 commit comments

Comments
 (0)