Collate Test Support API

Admin-only read-only search introspection for tests

Operations 8

GET /v1/test-support/search/alias Backing indices for an alias #
GET /v1/test-support/search/cluster-alias The server's configured search cluster alias (index name prefix) #
GET /v1/test-support/search/count Document count for an index/alias #
POST /v1/test-support/search/count Document count for an index/alias matching a query #
GET /v1/test-support/search/exists Whether an index or alias exists #
GET /v1/test-support/search/indices Index names matching a pattern (_cat/indices) #
GET /v1/test-support/search/mapping Mapping for an index/alias #
POST /v1/test-support/search/search Search an index/alias with a query body #

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/collate:collate-testsupport-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

collate-testsupport-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OpenMetadata Test Support API
  description: Common types and API definition for OpenMetadata
  contact:
    name: OpenMetadata
    url: https://open-metadata.org
    email: openmetadata-dev@googlegroups.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 2.0.5
servers:
- url: /api
  description: Current Host
- url: http://localhost:8585/api
  description: Endpoint URL
security:
- BearerAuth: []
tags:
- name: TestSupport
  description: Admin-only read-only search introspection for tests
paths:
  /v1/test-support/search/alias:
    get:
      tags:
      - TestSupport
      summary: Backing indices for an alias
      operationId: testSupportSearchAlias
      parameters:
      - name: name
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Raw engine alias response
  /v1/test-support/search/cluster-alias:
    get:
      tags:
      - TestSupport
      summary: The server's configured search cluster alias (index name prefix)
      operationId: testSupportClusterAlias
      responses:
        '200':
          description: '{"clusterAlias": string}'
  /v1/test-support/search/count:
    get:
      tags:
      - TestSupport
      summary: Document count for an index/alias
      operationId: testSupportSearchCount
      parameters:
      - name: index
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Raw engine count response
    post:
      tags:
      - TestSupport
      summary: Document count for an index/alias matching a query
      operationId: testSupportSearchCountWithQuery
      parameters:
      - name: index
        in: query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: Raw engine count response
  /v1/test-support/search/exists:
    get:
      tags:
      - TestSupport
      summary: Whether an index or alias exists
      operationId: testSupportSearchExists
      parameters:
      - name: index
        in: query
        schema:
          type: string
      - name: alias
        in: query
        schema:
          type: string
      responses:
        '200':
          description: '{"exists": boolean}'
  /v1/test-support/search/indices:
    get:
      tags:
      - TestSupport
      summary: Index names matching a pattern (_cat/indices)
      operationId: testSupportSearchIndices
      parameters:
      - name: pattern
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Raw engine _cat response
  /v1/test-support/search/mapping:
    get:
      tags:
      - TestSupport
      summary: Mapping for an index/alias
      operationId: testSupportSearchMapping
      parameters:
      - name: index
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Raw engine mapping response
  /v1/test-support/search/search:
    post:
      tags:
      - TestSupport
      summary: Search an index/alias with a query body
      operationId: testSupportSearchQuery
      parameters:
      - name: index
        in: query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
      responses:
        '200':
          description: Raw engine search response
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: Collate
  source: https://sandbox.open-metadata.org/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)