search

Search Wiki page match snippets

Changed on

Returns cursor-based snippets for one matching Wiki page.

get/search/wiki/matches

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Query parameters

remoteNodestring

name of the remote node

workspacestring

Workspace selector. For list and search APIs, use all, default, or a workspace name. Omitted means all.

pathstring required

Relative Wiki page path without extension, for example runbooks/deploy-guide. Must not start with / or contain ..

Wiki page path (may include slashes for nested pages)

qstring required

A search query string

cursorstring

Opaque cursor returned by the previous search response

limitinteger

Number of search match snippets to return (default 5, max 50)

Response

Cursor-based Wiki page match snippets

hasMoreboolean required
nextCursorstring

Changes