Search across the workspace

One query across issues (STRIX id, title, CVE, CWE, host), pentests, PR reviews (repository, title, number), chats, repositories, domains, network connectors and schedules. Results come back grouped by kind, each group ranked exact match first, then prefix, then substring, newest first within a rank. Only the kinds the token has a read scope for are searched (vulnerabilities:read for issues, scans:read for pentests, pr_reviews:read, chat:read, assets:read for repositories and domains, connectors:read, schedules:read); kinds outside the token’s scopes are skipped, and the same asset scopes and plan features apply as on each kind’s own list endpoint. An empty q returns the most recent items of each kind. A kind whose lookup failed is listed in failed while the other groups are still returned.

GET

Error

A valid request URL is required to generate request examples

{
  "query": "<string>",
  "groups": [
    {
      "kind": "issue",
      "items": [
        {
          "kind": "issue",
          "id": "<string>",
          "title": "<string>",
          "href": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "identifier": "<string>",
          "subtitle": "<string>",
          "status": "<string>",
          "severity": "critical"
        }
      ],
      "truncated": true
    }
  ],
  "failed": [
    "issue"
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Query Parameters

string

Search text, at most 200 characters. Empty returns recent items.

Maximum string length: 200

kinds

string

Comma-separated kinds to search. Defaults to every kind the token can read.

Example:

"issue,pentest"

limit

integer

default:5

Maximum results per kind.

Required range: 1 <= x <= 20

Response

Grouped search results.

query

string

required

The normalized query that was searched.

groups

object[]

required

One group per kind with at least one result, in the fixed kind order.

Show child attributes

failed

enum<string>[]

required

Kinds whose lookup failed; their results are missing from groups.

The kind of record a search result points at.

Available options:

issue,

pentest,

pr_review,

chat,

repository,

domain,

network,

schedule

Error

A valid request URL is required to generate request examples

{
  "query": "<string>",
  "groups": [
    {
      "kind": "issue",
      "items": [
        {
          "kind": "issue",
          "id": "<string>",
          "title": "<string>",
          "href": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "identifier": "<string>",
          "subtitle": "<string>",
          "status": "<string>",
          "severity": "critical"
        }
      ],
      "truncated": true
    }
  ],
  "failed": [
    "issue"
  ]
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Repositories

Search across the workspace

Authorizations

Query Parameters

Response