Search

Search resources

Changed on

Search indexed resources the caller is allowed to read. Authorization is evaluated with ReBAC grant scopes and confirmed with a per-hit permission check. total_count is never returned.

get/v1/search

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/search
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token)

Query parameters

qstring

Full-text query. Empty returns a filter-only page.

typesstring[]

Restrict results to these resource types.

organization_idstring
Example:9bsv0s46s6s002p9ltq0

Restrict results to this organization xid.

namespace_idstring
Example:9bsv0s46s6s002p9ltq0

Restrict results to this namespace xid.

project_idstring
Example:9bsv0s46s6s002p9ltq0

Restrict results to this project xid.

page_sizeinteger

Maximum number of search hits to return.

page_tokenstring

Opaque continuation token from a previous page_info.next_page_token.

Response

OK

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 836ecb425096Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status