BIG-IP F5 icon

BIG-IP F5

Interact with F5 BIG-IP via the iControl REST API

APM → Update Access Policy

AI-generated

Summary

Modifies an existing BIG-IP APM access policy by sending a PATCH request with the name and/or description fields you choose to change.

Inputs

  • Policy ID (required) — ID or name of the APM access policy to update. It is inserted into the request path /apm/policies/{policyId}.
  • Update Fields — Collection of optional fields to change. 'Name' sets a new policy name and 'Description' sets the description. Each is sent in the PATCH body only if added.
  • Request Options — Node settings for the HTTP request: batching (items per batch and interval in ms), ignore SSL issues, proxy URL, and timeout in ms (default 10000).

Output shape

The parsed JSON response from the BIG-IP iControl REST API for the PATCH request. This is typically the updated policy object. One request is made per input item.

The source doesn't define any response post-processing, so the shape is whatever BIG-IP returns. Errors from the API surface as node errors. The request uses the host and SSL settings from the bigIpF5Api credential. The path is /apm/policies/... without the /mgmt/tm prefix that other operations use, so it may not match the standard iControl REST path on every device.

Examples

Example 1: Rename an access policy

Policy ID: my_access_policy; Update Fields: add Name = corp_access_policy_v2.

Example 2: Update a policy description from a workflow

Policy ID: my_access_policy; Update Fields: add Description = an expression such as {{ $json.changeNote }}.

Links

Discussion