Grep

POST

api

repos

{repo_name}

grep

Grep

curl --request POST \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name}/grep \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context": {
    "after": 1,
    "before": 0
  },
  "pagination": {
    "limit": 50
  },
  "query": {
    "case_sensitive": true,
    "pattern": "ephemeral branches"
  },
  "rev": "main"
}
'

import requests

url = "https://api.{cluster}.code.storage/api/repos/{repo_name}/grep"

payload = {
    "context": {
        "after": 1,
        "before": 0
    },
    "pagination": { "limit": 50 },
    "query": {
        "case_sensitive": True,
        "pattern": "ephemeral branches"
    },
    "rev": "main"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    context: {after: 1, before: 0},
    pagination: {limit: 50},
    query: {case_sensitive: true, pattern: 'ephemeral branches'},
    rev: 'main'
  })
};

fetch('https://api.{cluster}.code.storage/api/repos/{repo_name}/grep', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{cluster}.code.storage/api/repos/{repo_name}/grep",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'context' => [
        'after' => 1,
        'before' => 0
    ],
    'pagination' => [
        'limit' => 50
    ],
    'query' => [
        'case_sensitive' => true,
        'pattern' => 'ephemeral branches'
    ],
    'rev' => 'main'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{cluster}.code.storage/api/repos/{repo_name}/grep"

	payload := strings.NewReader("{\n  \"context\": {\n    \"after\": 1,\n    \"before\": 0\n  },\n  \"pagination\": {\n    \"limit\": 50\n  },\n  \"query\": {\n    \"case_sensitive\": true,\n    \"pattern\": \"ephemeral branches\"\n  },\n  \"rev\": \"main\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{cluster}.code.storage/api/repos/{repo_name}/grep")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"context\": {\n    \"after\": 1,\n    \"before\": 0\n  },\n  \"pagination\": {\n    \"limit\": 50\n  },\n  \"query\": {\n    \"case_sensitive\": true,\n    \"pattern\": \"ephemeral branches\"\n  },\n  \"rev\": \"main\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/repos/{repo_name}/grep")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"context\": {\n    \"after\": 1,\n    \"before\": 0\n  },\n  \"pagination\": {\n    \"limit\": 50\n  },\n  \"query\": {\n    \"case_sensitive\": true,\n    \"pattern\": \"ephemeral branches\"\n  },\n  \"rev\": \"main\"\n}"

response = http.request(request)
puts response.read_body

{
  "has_more": true,
  "incomplete_results": false,
  "matches": [
    {
      "path": "app/blog/markdown/ephemeral-branches.md"
    }
  ],
  "query": {
    "case_sensitive": true,
    "pattern": "ephemeral branches"
  },
  "repo": {
    "commit": "b003fc78805954584e1ee364a4ad39d7c79e819a",
    "ref": "main"
  }
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

repo_name

string

required

Repository name. Names that contain / or any other character that is not safe in a URL path segment must be URL encoded so the value occupies a single path segment. For example pierre/example is sent as pierre%2Fexample. Plain names such as example can be sent as-is. The server URL-decodes the value before resolving the repository.

Body

application/json

Search repository contents by pattern. Optional file filters, context lines, and pagination let you retrieve only the relevant slices for agents and tools.

Grep request describing the pattern, ref, filters, limits, and pagination for a repository content search.

query

object

required

Pattern configuration.

Show child attributes

rev

string

required

Legacy ref field retained for backwards compatibility. Prefer the ref field for new callers.

Example:

"main"

context

object

Lines of context to include before and after each match.

Show child attributes

ephemeral

boolean

Whether ref should be resolved from the ephemeral namespace.

file_filters

object

Optional include and exclude filters applied before matching.

Show child attributes

limits

object

Maximum line and per-file match limits.

Show child attributes

pagination

object

Cursor-based pagination controls for large result sets.

Show child attributes

paths

string[]

Optional path prefixes used to narrow the search before pattern matching.

Repository-relative path used to scope the operation.

ref

string

Preferred branch, tag, or commit to search.

Response

Search results for the requested pattern.

Grep results grouped per file, including the resolved ref and pagination state.

has_more

boolean

required

Whether additional matches remain.

Example:

true

incomplete_results

boolean

required

True when the result set is incomplete because the server-side output cap was reached. Matches beyond the cap exist in the repo but cannot be retrieved by paging: narrow the query (pattern, paths, file filters) or raise max_lines if it was set below the maximum. next_cursor still pages through everything collected below the cap.

Example:

false

matches

object[]

required

Files that matched the query, each with matching and context lines.

Show child attributes

next_cursor

string | null

required

Opaque cursor for the next page, if any.

query

object

required

The effective query settings used by the server.

Show child attributes

repo

object

required

Resolved repository ref and commit used for the search.

Show child attributes

Grep

curl --request POST \
  --url https://api.{cluster}.code.storage/api/repos/{repo_name}/grep \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context": {
    "after": 1,
    "before": 0
  },
  "pagination": {
    "limit": 50
  },
  "query": {
    "case_sensitive": true,
    "pattern": "ephemeral branches"
  },
  "rev": "main"
}
'

import requests

url = "https://api.{cluster}.code.storage/api/repos/{repo_name}/grep"

payload = {
    "context": {
        "after": 1,
        "before": 0
    },
    "pagination": { "limit": 50 },
    "query": {
        "case_sensitive": True,
        "pattern": "ephemeral branches"
    },
    "rev": "main"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    context: {after: 1, before: 0},
    pagination: {limit: 50},
    query: {case_sensitive: true, pattern: 'ephemeral branches'},
    rev: 'main'
  })
};

fetch('https://api.{cluster}.code.storage/api/repos/{repo_name}/grep', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{cluster}.code.storage/api/repos/{repo_name}/grep",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'context' => [
        'after' => 1,
        'before' => 0
    ],
    'pagination' => [
        'limit' => 50
    ],
    'query' => [
        'case_sensitive' => true,
        'pattern' => 'ephemeral branches'
    ],
    'rev' => 'main'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{cluster}.code.storage/api/repos/{repo_name}/grep"

	payload := strings.NewReader("{\n  \"context\": {\n    \"after\": 1,\n    \"before\": 0\n  },\n  \"pagination\": {\n    \"limit\": 50\n  },\n  \"query\": {\n    \"case_sensitive\": true,\n    \"pattern\": \"ephemeral branches\"\n  },\n  \"rev\": \"main\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{cluster}.code.storage/api/repos/{repo_name}/grep")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"context\": {\n    \"after\": 1,\n    \"before\": 0\n  },\n  \"pagination\": {\n    \"limit\": 50\n  },\n  \"query\": {\n    \"case_sensitive\": true,\n    \"pattern\": \"ephemeral branches\"\n  },\n  \"rev\": \"main\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{cluster}.code.storage/api/repos/{repo_name}/grep")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"context\": {\n    \"after\": 1,\n    \"before\": 0\n  },\n  \"pagination\": {\n    \"limit\": 50\n  },\n  \"query\": {\n    \"case_sensitive\": true,\n    \"pattern\": \"ephemeral branches\"\n  },\n  \"rev\": \"main\"\n}"

response = http.request(request)
puts response.read_body

{
  "has_more": true,
  "incomplete_results": false,
  "matches": [
    {
      "path": "app/blog/markdown/ephemeral-branches.md"
    }
  ],
  "query": {
    "case_sensitive": true,
    "pattern": "ephemeral branches"
  },
  "repo": {
    "commit": "b003fc78805954584e1ee364a4ad39d7c79e819a",
    "ref": "main"
  }
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

{
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "error": "<string>",
  "instance": "<string>"
}

Getting Started

Features

Workflows

Reference

JWT claims

Authorizations

Path Parameters

Body

Response