Git

Search source files

Search source text at a branch, tag, or commit SHA. The response includes the resolved commit and a pagination cursor.

get/v1/spaces/{spaceId}/source/search

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/spaces/{spaceId}/source/search
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.spacefast.com/v1/auth/oauth2/authorize, token URL https://api.spacefast.com/v1/auth/oauth2/token; client credentials, token URL https://api.spacefast.com/v1/auth/oauth2/token, scopes: spaces:read)

Path parameters

spaceIdstring required

Query parameters

connectionType'connected' | 'hosted'

Which of the space's repository connections to act on: connected for the repository you linked from a provider, hosted for the one Spacefast hosts and you push to.

refstring

Branch, tag, or commit SHA to read. Defaults to the repository's default branch.

patternstring required

Regular expression to search file contents for.

caseSensitivestring

Match the pattern case-sensitively. Defaults to case-insensitive.

string
OR
string[]
string
OR
string[]
string
OR
string[]
string
OR
string[]
contextBeforeinteger

Lines of context to return before each match.

contextAfterinteger

Lines of context to return after each match.

maxLinesinteger

Ceiling on total lines returned across all matches.

maxMatchesPerFileinteger

Ceiling on matches returned per file.

cursorstring

Opaque cursor from the previous page's pagination.nextCursor.

limitinteger

Maximum matching files to return.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

No recorded changes to this operation across all 1 revision of this API.