F5 Insight Postman collection

Articles Community CodeShare
1

Problem this solution solves

Developers needed a simpler way to explore and test the Insight API without manually configuring requests. Exporting the API to a Postman collection provides a ready-to-use set of requests that streamlines onboarding, debugging, and integration development.

This contribution exports the F5 Insight API into a reusable Postman collection, reducing the need to configure individual requests manually. The collection provides a starting point for exploring API operations, validating requests, and troubleshooting integrations.

How to use this solution

  1. Requirements: Postman, access to F5 Insight, and valid API credentials with permissions for the operations you intend to perform.
  2. Download the F5 Insight Postman collection JSON file provided with this contribution.
  3. In Postman, select Import and upload the collection.
  4. Configure the API base URL and authentication settings required by your F5 Insight environment.
  5. Review the selected request and update any required path parameters, query parameters, or request body fields.
  6. Select Send to execute the request, then review the response status and body.

The Solution

Use Postman variables to keep environment-specific values separate from request definitions. For example, define a base_url variable containing the API base URL for your environment:

Variable: base_url

Value:

{{base_url}}/

Configure authentication according to the F5 Insight API documentation. Where requests use collection-level authentication, set them to Inherit auth from parent. Keep credentials in Postman Vault or another approved secret-storage mechanism rather than embedding them in the exported collection.

The Full API is located here: F5 Insight API

Notes and Limitations

  1. A Postman collection does not grant API access; valid credentials and appropriate permissions are required.
  2. The collection reflects the API definition available at the time of export. Future API changes may require updates.
  3. Environment-specific values and request inputs must be configured before use.
  4. Some requests may modify or delete resources. Review each operation carefully and use a non-production environment where possible.
  5. API rate limits, authentication requirements, and service-side restrictions still apply.
  6. Importing the collection does not establish that every request has been tested successfully. Document the scope of validation alongside the tested versions.
  7. Do not include credentials, tokens, or sensitive response data when sharing the collection or screenshots.

While we update https://clouddocs.f5.com with the proper hosting for the collection, you can download it via .pdf and copy and paste into Postman.

F5 Insight API.postman_collection.pdf (91.4 KB)