---
title: Flow Control REST API
description: The Flow Control API is used to fetch details of all connections that exceeded the threshold value for client spike, server spike, connection queued, connection rejected, bytes-in spike, and bytes-out spike.
component: pingintelligence
version: 5.1
page_id: pingintelligence:abs_ai_engine:pingintelligence_flow_control_rest_api
canonical_url: https://docs.pingidentity.com/pingintelligence/5.1/abs_ai_engine/pingintelligence_flow_control_rest_api.html
revdate: March 27, 2024
---

# Flow Control REST API

The Flow Control API is used to fetch details of all connections that exceeded the threshold value for client spike, server spike, connection queued, connection rejected, bytes-in spike, and bytes-out spike.

|   |                                                                                |
| - | ------------------------------------------------------------------------------ |
|   | The flow control report is only available when ASE is deployed in inline mode. |

**Method**: GET

**URL**: `/v4/abs/flowcontrol?later_date=<>&earlier_date=<>&api=<api_name>`

|                | **Header** | **Value**  |
| -------------- | ---------- | ---------- |
| **Access Key** | `x-abs-ak` | `<string>` |
| **Secret Key** | `x-abs-sk` | `<string>` |

**Sample response**

```json
{
 "company": "ping identity",
 "name": "api_flowcontrol",
 "description": "This report contains flow control information for the
  specified API.",
 "earlier_date": "Wed Jan 01 08:20:00:000 2018",
 "later_date": "Sun Jan 05 13:20:00:000 2018",
 "api_name": "websocket",
 "summary": {
 "client_spike": 610,
 "connection_queued": 0,
 "connection_quota_exceeded": 0,
 "bytes_in_spike": 2743,
 "bytes_out_spike": 287
 },
 "details": {
 "client_spike": [],
 "server_spike": [
 {
 "request_time": "Fri Jan 09 17:19:55:977 2016",
 "connection_id": "147378243",
 "source_ip": "100.64.26.163",
 "destination_api": "/atmapp/login"
 },
 {
 "request_time": "Fri Jan 09 17:19:55:991 2016",
 "connection_id": "1919058221",
 "source_ip": "100.64.20.230",
 "destination_api": "/atmapp/zipcode"
 }
 ],
 "connections_queued": [],
 "connections_rejected": [],
 "bytes_in_spike": [],
 "bytes_out_spike": []
 }
}
```