Verify instance onboarding

After installing and configuring NGINX Agent, verify that your F5 WAF for NGINX instances appear in NGINX Instance Manager.

You can view your F5 WAF for NGINX instances in the Instance Manager web interface. Follow these steps to confirm that NGINX Agent is installed and reporting data correctly.

  1. In a web browser, go to the FQDN for your NGINX Instance Manager host and log in. Then, select Instance Manager from the Launchpad menu.

  2. In the left menu, select Instances.

  3. Confirm that each instance lists an F5 WAF for NGINX version in the F5 WAF column.

  4. Select an instance and scroll to the F5 WAF Details section to verify its status and build information.

Use tools such as curl or Postman to send requests to the NGINX Instance Manager REST API. The API base URL is https://<NIM-FQDN>/api/[nim|platform]/<API_VERSION>.
All requests require authentication. For details on authentication methods, see the API overview.

Use the REST API to check version and status details for F5 WAF for NGINX.

Method Endpoint
GET /api/platform/v1/instances
GET /api/platform/v1/systems
  • Send a GET request to /api/platform/v1/systems to check version information.

    Example response:

    json
    {
      "count": 3,
      "items": [
        {
          "appProtect": {
            "attackSignatureVersion": "2022.11.16",
            "status": "active",
            "threatCampaignVersion": "2022.11.15",
            "version": "build-3.954.0"
          }
        }
      ]
    }
  • Send a GET request to /api/platform/v1/instances to check how many instances have F5 WAF for NGINX installed.

    Example response:

    json
    {
      "count": 3,
      "items": [
        [...]
      ],
      "nginxAppProtectWAFCount": 2,
      "nginxPlusCount": 3
    }