Network IP Range API in Aria Automation fails with the error "Check if the api version is supplied or correct. This request is not supported."

Products

• VMware Aria Suite

Issue/Introduction

When running the provided curl command available in the documentation Query for IP Addresses:

curl -X GET -H 'Content-Type: application/json' -H "Authorization: Bearer $access_token" "$url/iaas/api/network-ip-ranges/$ip_range_id/ip_addresses?apiVersion=$api_version"  | jq "."

you receive the following error:

{
  "message": "Invalid request: GET https://KUBERNETES_POD_IP:8282/iaas/api/network-ip-ranges/<IP RANGE ID>/ip_addresses. Check if the api version is supplied or correct. This request is not supported.",
  "statusCode": 400,
  "errorCode": 0,
  "serverErrorId": "UUID",
  "documentKind": "com:vmware:xenon:common:ServiceErrorResponse"
} 

Environment

Aria Automation 8.x

Cause

This error occurs due to a typographical error in the Query for IP Addresses documentation. The API endpoint is incorrectly documented as /ip_addresses while the correct endpoint is /ip-addresses.

Resolution

Use the following corrected command to query for IP addresses:

curl -X GET -H 'Content-Type: application/json' -H "Authorization: Bearer $access_token" "$url/iaas/api/network-ip-ranges/$ip_range_id/ip-addresses?apiVersion=$api_version"  | jq "."

The documentation team is actively working on updating the documentation to reflect the correct API endpoint.