Prerender API reference

New to Corsair? See API access, authentication, and error handling.

Cache

clear

cache.clear Delete cached URLs matching a pattern. The clear runs as a job, and only one runs at a time Risk: destructive

await corsair.prerender.api.cache.clear({ query: 'https://example.com%' });

Input

Name	Type	Required	Description
`query`	`string`	Yes	A SQL-like pattern: `%` matches any run of characters, `?` matches one. A trailing `%` clears everything under that prefix.

Output

Name	Type	Required	Description
`message`	`string \| null`	No	—
`success`	`boolean \| null`	No	—

clearStatus

cache.clearStatus Read whether a cache clear job is still running: inProgress is true while one runs Risk: read

await corsair.prerender.api.cache.clearStatus({});

Input: empty object Output

Name	Type	Required	Description
`message`	`string \| null`	No	—
`inProgress`	`boolean`	Yes	True while a clear job is running.

recache

cache.recache Render and cache one URL, or up to 1000 in one call, so crawlers see current content. Each URL spends one render from the plan, billed past the included amount Risk: destructive

await corsair.prerender.api.cache.recache({ url: 'https://example.com/pricing' });

Input

Name	Type	Required	Description
`url`	`string`	No	An absolute URL, including its scheme.
`urls`	`string[]`	No	Up to 1000 URLs, which is the API limit per request.
`adaptiveType`	`desktop \| mobile`	No	Which cached variant to act on. Defaults to desktop.

Output

Name	Type	Required	Description
`message`	`string \| null`	No	—
`success`	`boolean \| null`	No	—

search

cache.search Search the cache by substring or exact URL, or list all of it, 200 results per page, optionally filtered by device Risk: read

await corsair.prerender.api.cache.search({ query: 'example.com/path', start: 0 });

Input

Name	Type	Required	Description
`query`	`string`	No	A substring match against the cached URLs.
`exactMatch`	`string`	No	Only the URL identical to this. When both are given, only this is used.
`start`	`number`	No	Paging offset. Each page holds 200 URLs.
`adaptiveType`	`desktop \| mobile`	No	Which cached variant to act on. Defaults to desktop.

Output

Name	Type	Required	Description
`urls`	`object[]`	Yes	—

urls full type

{
  url?: string | null,
  domain?: string | null,
  adaptiveType?: string | null,
  cacheState?: string | null,
  lastRefresh?: string | null,
  requestedRecacheAt?: string | null
}[]

sitemap

cache.sitemap Render and cache every URL in a sitemap that is not cached yet, spending one render per new URL. URLs already cached are left as they are Risk: destructive

await corsair.prerender.api.cache.sitemap({ url: 'https://example.com/sitemap.xml' });

Input

Name	Type	Required	Description
`url`	`string`	Yes	The sitemap XML URL to read new URLs from.
`adaptiveType`	`desktop \| mobile`	No	Which cached variant to act on. Defaults to desktop.

Output

Name	Type	Required	Description
`message`	`string \| null`	No	—
`success`	`boolean \| null`	No	—

Queue

changeSpeed

queue.changeSpeed Set how many URLs the render queue processes per hour, or restore the automatic delay. A faster rate can overload the origin Risk: write

await corsair.prerender.api.queue.changeSpeed({ urlsPerHour: 18000 });

Input

Name	Type	Required	Description
`urlsPerHour`	`number`	Yes	How many URLs to recache per hour. `0` restores the automatic delay.

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`recacheMetrics`	`object \| null`	No	—
`isAutomaticDelay`	`boolean`	Yes	—

recacheMetrics full type

{
  delayBetweenURLs?: number | null,
  num10Sec?: number | null,
  num30Sec?: number | null,
  num1Min?: number | null,
  num10Min?: number | null,
  num1Hour?: number | null,
  num1Day?: number | null
} | null

Overview

Plugins

Prerender API reference

Cache

clear

clearStatus

recache

search

sitemap

Queue

changeSpeed