IBM API Connect · Schema

ScrollRequest

API GatewayAPI ManagementDeveloper PortalDeveloper ToolsIBM

Properties

Name Type Description
size number The number of results that you want returned for each batch. Defaults to 1000. Requests with a scroll_id will ignore this field.
scroll string Tell OpenSearch how long you need to keep scrolling. Defaults to '10m'. This search context needs to be long enough to process a single batch of results.
scroll_id string Pass this scroll ID to the scroll operation to get back the next batch of results.
View JSON Schema on GitHub

JSON Schema

ibm-api-connect-scroll-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-scroll-request-schema.json",
  "title": "ScrollRequest",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-analytics-api-openapi.yml#/components/schemas/ScrollRequest",
  "type": "object",
  "properties": {
    "size": {
      "type": "number",
      "description": "The number of results that you want returned for each batch. Defaults to 1000. Requests with a scroll_id will ignore this field.\n"
    },
    "scroll": {
      "type": "string",
      "description": "Tell OpenSearch how long you need to keep scrolling. Defaults to '10m'. This search context needs to be long enough to process a single batch of results.\n"
    },
    "scroll_id": {
      "type": "string",
      "description": "Pass this scroll ID to the scroll operation to get back the next batch of results."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ibm-api-connect-scroll-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.