North Connectors

Search files in cache, error and archive folders

Searches for files in the north connector cache

get/api/north/{northId}/cache/search

Path parameters

northIdstring required

Query parameters

nameContainsstring required

startstring required

endstring required

maxNumberOfFilesReturnednumber double required

Response

The cache search result

searchDatestring required

Represents an instant in time as an ISO 8601 string.

Example response

{
  "searchDate": "2023-10-31T12:34:56.789Z",
  "metrics": {
    "lastRunDuration": 1000,
    "lastRunStart": "2023-10-31T12:34:56.789Z",
    "lastConnection": "2023-10-31T12:34:56.789Z"
  },
  "error": [
    {
      "metadata": {
        "contentFile": "/path/to/content.json",
        "contentSize": 1024,
        "numberOfElement": 10,
        "createdAt": "2023-10-31T12:34:56.789Z",
        "contentType": "time-values"
      }
    }
  ],
  "archive": [
    {
      "metadata": {
        "contentFile": "/path/to/content.json",
        "contentSize": 1024,
        "numberOfElement": 10,
        "createdAt": "2023-10-31T12:34:56.789Z",
        "contentType": "time-values"
      }
    }
  ],
  "cache": [
    {
      "metadata": {
        "contentFile": "/path/to/content.json",
        "contentSize": 1024,
        "numberOfElement": 10,
        "createdAt": "2023-10-31T12:34:56.789Z",
        "contentType": "time-values"
      }
    }
  ]
}

Changes

Changed in 6 of the 73 revisions of this API.21411

Feb 3, 2026bb7c469357f8215See the full diff
- ▲
  added the new required query request parameter maxNumberOfFilesReturned
  new-required-request-parameter
- ▲
  the response's body type/format changed from array/ to object/ for status 200
  response-body-type-changed
- ●
  deleted the query request parameter folder
  request-parameter-removed
- ○
  added the required property archive to the response with the 200 status
  response-required-property-added
- ○
  added the required property cache to the response with the 200 status
  response-required-property-added
- ○
  added the required property error to the response with the 200 status
  response-required-property-added
- ○
  added the required property metrics to the response with the 200 status
  response-required-property-added
- ○
  added the required property searchDate to the response with the 200 status
  response-required-property-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 26, 2026a291063e086b71See the full diff
- ▲
  added the new required query request parameter folder
  new-required-request-parameter
- ▲
  the response's body type/format changed from object/ to array/ for status 200
  response-body-type-changed
- ▲
  removed the required property archive from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property cache from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property metrics from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property searchDate from the response with the 200 status
  response-required-property-removed
- ●
  deleted the query request parameter maxNumberOfFilesReturned
  request-parameter-removed
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 19, 2026f7d0cb77f2c5215See the full diff
- ▲
  added the new required query request parameter maxNumberOfFilesReturned
  new-required-request-parameter
- ▲
  the response's body type/format changed from array/ to object/ for status 200
  response-body-type-changed
- ●
  deleted the query request parameter folder
  request-parameter-removed
- ○
  added the required property archive to the response with the 200 status
  response-required-property-added
- ○
  added the required property cache to the response with the 200 status
  response-required-property-added
- ○
  added the required property error to the response with the 200 status
  response-required-property-added
- ○
  added the required property metrics to the response with the 200 status
  response-required-property-added
- ○
  added the required property searchDate to the response with the 200 status
  response-required-property-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 9, 20265f6d5e8578191See the full diff
- ▲
  removed the required property items/metadata/source from the response with the 200 status
  response-required-property-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 8, 2026c9d70c72b84a21See the full diff
- ▲
  the items/metadata/source response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property items/metadata/options from the response with the 200 status
  response-required-property-removed
- ○
  added CacheMetadataSourceOriginSouth CacheMetadataSourceOriginOIAnalytics CacheMetadataSourceOriginAPI CacheMetadataSourceOriginTest to the items/metadata/source response property anyOf list for the response status 200
  response-property-any-of-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 6, 2026d8e7a58e006a71See the full diff
- ▲
  added the new required query request parameter folder
  new-required-request-parameter
- ▲
  the response's body type/format changed from object/ to array/ for status 200
  response-body-type-changed
- ▲
  removed the required property archive from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property cache from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property metrics from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property searchDate from the response with the 200 status
  response-required-property-removed
- ●
  deleted the query request parameter maxNumberOfFilesReturned
  request-parameter-removed
This revision also has 219 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history