Search file text

fileTextSearch(input: FileTextSearchInput!): FileTextSearchResult!

Requires project.files.read.

Arguments

ArgumentTypeRequired
inputFileTextSearchInput!Yes

Input fields

input

FileTextSearchInput

FieldTypeRequiredDescription
projectReferenceStringNoProject UUID, slug or configured domain. Omit it to use the project of the request.
refStringNoContent to search: main, branch:<name-or-id>, release:<version> or env:<name>. Omit for main.
queryString!YesLiteral text to find, or a regular expression when isRegex is true.
patternStringNoFile path pattern, for example .tsx or pages/.
isRegexBooleanNoRead query as a regular expression (default false).
caseSensitiveBooleanNoMatch letter case exactly (default false).
limitIntNoLargest number of matching files, 1 to 100 (default 50). It limits files, not matching lines.

Response

Returns FileTextSearchResult!. Open the type for its fields and nested types.

FieldType
data[FileTextSearchFile!]!
totalMatchesInt!

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query FileTextSearch($input: FileTextSearchInput!) {
  fileTextSearch(input: $input) {
    totalMatches
    data {
      path
      versionId
    }
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "query": "example"
  }
}