Prewarm a site's search cache

Hints the search backend that latency-sensitive site search requests are likely to arrive soon. Call this when a visitor opens the site's search interface.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Responses

204

Search cache warmup accepted

No content

post/orgs/{organizationId}/sites/{siteId}/search/prewarm

POST /v1/orgs/{organizationId}/sites/{siteId}/search/prewarm HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Search cache warmup accepted

No content