Scan tenant blocked values using pagination
Learn how to scan all tenant-level blocked values using cursor-based pagination.
The Scan tenant blocked values API retrieves all tenant-level blocked values using cursor-based pagination. It returns results in pages and includes a scrollId in each response.
You use this scrollId in subsequent requests to retrieve the next set of results. This approach enables efficient retrieval of large datasets without duplication or overlap.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
POST /configuration/{tenantId}/autopilot/blockedValues/_dbscan?limit={limit}This endpoint scans tenant-level blocked values and returns results in pages using a cursor.
The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
tenantId | String | Yes | Tenant identifier. |
Query parameters
The following table describes the query parameters.
| Parameter | Type | Required | Description | Accepted values / Default |
|---|---|---|---|---|
limit | Integer | No | Number of records to return per page. | Default: 100, max: 100 |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {token} | Yes |
Request body
For the first request, omit the request body or set it to null. For subsequent requests, include the scrollId returned in the previous response in the request body. For example, use the scroll ID: "xyz" in the next request.
Response body
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
scrollId | String | Cursor value used to retrieve the next page of results. |
values | Array | List of blocked value objects returned in the current page. |
tenantId | String | The identifier of the tenant. |
value | String | The blocked value. |
createdAt | Number | The timestamp when the blocked value was created, in epoch milliseconds. |
createdBy | String | The identifier of the user who created the blocked value. |
Example response
The following example shows a response containing a page of blocked values.
{
"scrollId": "abc123",
"values": [
{
"tenantId": "my_tenant",
"value": "N/A",
"createdAt": 1704153600000,
"createdBy": "admin@company.com"
}
]
}