BIG-IP F5 icon

BIG-IP F5

Interact with F5 BIG-IP via the iControl REST API

Actions38

APM → Delete Session

AI-generated

Summary

Terminates and removes an active APM user session on an F5 BIG-IP by sending a DELETE request to the iControl REST endpoint /mgmt/tm/apm/session/{sessionId}.

Inputs

  • Session ID (required) — Unique ID of the APM user session to terminate. It is inserted into the request URL path. Session IDs can be found with the Get All Sessions operation.
  • Request Options — Optional node-level HTTP settings. Batching sets items per batch (default 50, -1 disables) and the interval between batches (default 1000 ms). Ignore SSL Issues accepts unverifiable certificates. Proxy sets an HTTP proxy URL, optionally with credentials. Timeout is the wait for response headers in ms (default 10000).

Output shape

The JSON response from the BIG-IP for the DELETE request, one result per input item. No request body is sent.

The source defines only the declarative routing, so the response contents are not specified there. iControl REST delete calls typically return an empty or minimal body. A missing or invalid session ID will likely produce an error from the BIG-IP. The host and SSL behaviour come from the bigIpF5Api credential.

Examples

Example 1: Force-logout a specific user's APM session after a security alert.

Resource: APM, Operation: Delete Session, Session ID set to the session ID from an earlier Get All Sessions step, e.g. {{$json.sessionId}}.

Example 2: Delete many sessions from a list without overloading the BIG-IP.

Feed one item per session. Set Session ID to an expression. Under Request Options, enable Batching with Items per Batch 10 and Batch Interval 2000 ms.

Links

Discussion