BIG-IP F5 icon

BIG-IP F5

Interact with F5 BIG-IP via the iControl REST API

APM → Get Access Policy

AI-generated

Summary

Retrieves the details of a single APM (Access Policy Manager) access policy from an F5 BIG-IP by sending a GET request to /apm/policies/{policyId}.

Inputs

  • Policy ID (required) — ID or name of the APM access policy to fetch (e.g. my_access_policy). It is inserted into the request URL path.
  • Request Options — Optional node settings. Batching sets items per batch and the interval in ms between batches. Ignore SSL Issues accepts responses even when the certificate can't be validated. Proxy sets an HTTP proxy URL, optionally with credentials. Timeout sets the ms to wait for response headers (default 10000).

Output shape

The JSON response from the BIG-IP for the requested policy, returned as the node's output item.

The exact fields depend on what the BIG-IP returns. The request uses the host from the bigIpF5Api credential as its base URL. The path is /apm/policies/... with no /mgmt/tm prefix, unlike most other operations in this node, so it may not resolve on every BIG-IP setup. A non-existent policy ID will likely produce an HTTP error.

Examples

Example 1: Fetch a known access policy so a later node can inspect its configuration.

Resource: APM; Operation: Get Access Policy; Policy ID: my_access_policy.

Example 2: Query a BIG-IP with a self-signed certificate through a proxy.

Policy ID: corp_vpn_policy; Request Options: Ignore SSL Issues on, Proxy http://myproxy:3128, Timeout 20000.

Links

Discussion