---
title: "Search files in cache, error and archive folders"
method: GET
path: "/api/north/{northId}/cache/search"
tags: ["North Connectors"]
---

# Search files in cache, error and archive folders

`GET /api/north/{northId}/cache/search`

Searches for files in the north connector cache

## Path parameters

- `northId` string, required

## Query parameters

- `nameContains` string, required
- `start` string, required
- `end` string, required
- `maxNumberOfFilesReturned` number, double, required

## Response `200`

The cache search result

- CacheSearchResult
  - `searchDate` string, required — Represents an instant in time as an ISO 8601 string.
  - `metrics` object, required
    - `currentArchiveSize` number, double, required — The current size of the archive.
    - `currentErrorSize` number, double, required — The current size of errors.
    - `currentCacheSize` number, double, required — The current size of the cache.
    - `lastRunDuration` number, double, nullable, required — The duration of the last run in milliseconds.
    - `lastRunStart` string, required — Represents an instant in time as an ISO 8601 string.
    - `lastConnection` string, required — Represents an instant in time as an ISO 8601 string.
  - `error` object[], required
    - `metadata` CacheMetadata, required — Metadata for cached content.
      - `contentFile` string, required — The path to the content file.
      - `contentSize` number, double, required — The size of the content in bytes.
      - `numberOfElement` number, double, required — The number of elements in the content.
      - `createdAt` string, required — Represents an instant in time as an ISO 8601 string.
      - `contentType` string, required — The type of the content.
    - `filename` string, required
  - `archive` object[], required
    - `metadata` CacheMetadata, required — Metadata for cached content.
      - `contentFile` string, required — The path to the content file.
      - `contentSize` number, double, required — The size of the content in bytes.
      - `numberOfElement` number, double, required — The number of elements in the content.
      - `createdAt` string, required — Represents an instant in time as an ISO 8601 string.
      - `contentType` string, required — The type of the content.
    - `filename` string, required
  - `cache` object[], required
    - `metadata` CacheMetadata, required — Metadata for cached content.
      - `contentFile` string, required — The path to the content file.
      - `contentSize` number, double, required — The size of the content in bytes.
      - `numberOfElement` number, double, required — The number of elements in the content.
      - `createdAt` string, required — Represents an instant in time as an ISO 8601 string.
      - `contentType` string, required — The type of the content.
    - `filename` string, required

## Changes

- **2026-02-03** `bb7c469357f8` — 2 breaking, 1 warning, 5 info
  - added the new required `query` request parameter `maxNumberOfFilesReturned`
  - the response's body type/format changed from `array`/`` to `object`/`` for status `200`
  - deleted the `query` request parameter `folder`
  - added the required property `archive` to the response with the `200` status
  - …4 more
- **2026-01-26** `a291063e086b` — 7 breaking, 1 warning
  - added the new required `query` request parameter `folder`
  - the response's body type/format changed from `object`/`` to `array`/`` for status `200`
  - removed the required property `archive` from the response with the `200` status
  - removed the required property `cache` from the response with the `200` status
  - …4 more
- **2026-01-19** `f7d0cb77f2c5` — 2 breaking, 1 warning, 5 info
  - added the new required `query` request parameter `maxNumberOfFilesReturned`
  - the response's body type/format changed from `array`/`` to `object`/`` for status `200`
  - deleted the `query` request parameter `folder`
  - added the required property `archive` to the response with the `200` status
  - …4 more
- **2026-01-09** `5f6d5e857819` — 1 breaking
  - removed the required property `items/metadata/source` from the response with the `200` status
- …earlier changes not shown

[Full history](https://skmtc.dev/optimistiksas/apis/oibus-api/changes/api/north/:northId/cache/search/get.md)

---

[API](https://skmtc.dev/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.dev/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/optimistiksas/oibus-api/revisions/fe8fd32c9fdc/schema)