검색에 대한 REST API 엔드포인트

Enterprise Cloud

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.14

Enterprise Server 3.15

Free, Pro, & Team

REST API

모든 GitHub 문서는 오픈 소스입니다. 잘못되었거나 명확하지 않은 사항이 있나요? 끌어오기 요청을 제출하세요.

이러한 문서를 멋지게 만들 수 있도록 도와주세요!

도메인 이름

GitHub Docs에서 찾으려면 검색어를 입력하세요.

누가 이 기능을 사용할 수 있나요?

actions

여러 권한이 필요하거나 다른 권한이 사용될 수 있습니다. 권한에 대한 자세한 내용은 이 엔드포인트에 대한 설명서를 참조하세요.

AI 도우미를 로드하는 동안 오류가 발생했습니다.

자동 완성 결과를 로드하는 동안 오류가 발생했습니다.

이 필드를 사용하여 문서를 검색할 수 있습니다.

검색에 대한 REST API 엔드포인트 - GitHub Enterprise Server 3.15 Docs

Use the REST API to search for specific items on GitHub.

빠른 시작

REST API 정보

GitHub의 API 비교

API 버전

호환성이 손상되는 변경

OpenAPI 설명

시작

속도 제한

페이지 매김

라이브러리

모범 사례

문제 해결

시간대

CORS 및 JSONP

이슈 이벤트 유형

GitHub 이벤트 유형

REST API 사용

인증

해당 API 자격 증명 보안 유지

GitHub 앱 설치 액세스 토큰에 대한 엔드포인트

GitHub 앱 사용자 토큰에 대한 엔드포인트

세분화된 PAT에 대한 엔드포인트

GitHub 앱에 필요한 권한

세분화된 PAT에 대한 권한

JavaScript를 사용하여 스크립트

Ruby를 사용하여 스크립트

사용자에 대한 리소스 검색

배포 제공

데이터를 그래프로 렌더링

주석 작업

CI 서버 빌드

시작 - Git 데이터베이스

시작 - 검사

비밀 암호화

가이드

Artifacts

캐시

OIDC

사용 권한

비밀

자체 호스팅 실행기 그룹

자체 호스팅 실행기

변수

워크플로 작업

워크플로 실행

워크플로

이벤트

피드

Notifications

별 지정

확인

활동

조직

알림 배너

GitHub Apps

설치

OAuth 권한 부여

웹후크

결제

분기

보호된 분기

검사 실행

검사 도구 모음

코드 검사

구성

코드 보안 설정

사용 규정

협력자

초대

커밋

커밋 주석

커밋 상태

경고

Dependabot

종속성 검토

종속성 제출

SBOM(소프트웨어 제품 구성 정보)

종속성 그래프

배포 키

배포 분기 정책

배포

환경

보호 규칙

배포 상태

이모지

관리자 통계

알림

감사 로그

코드 보안 및 분석

전역 웹후크

LDAP

라이선스

GHES 관리

조직 사전 수신 후크

사전 수신 환경

사전 수신 후크

리포지토리 사전 수신 후크

SCIM

사용자

엔터프라이즈 관리자

Gists

설명

Blob

참조

트리

Git 데이터베이스

gitignore

담당자

이슈

레이블

마일스톤

타임라인

Markdown

메타

통계

메트릭

마이그레이션

OAuth 앱 권한 부여

사용자 지정 속성

사용자 지정 역할

구성원

조직 역할

외부 협력자

개인용 액세스 토큰

규칙 도구 모음

규칙

보안 관리자

패키지

페이지

Boards

카드

Projects (classic)

끌어오기 요청

메모 검토

요청 검토

검토

반응

릴리스

릴리스 자산

자동 링크

콘텐츠

포크

Git LFS

리포지토리

검색

비밀 검사

글로벌 보안 공지

보안 공지

Teams

토론 의견

토론

외부 그룹

멤버

메일

팔로워

GPG 키

Git SSH 키

소셜 계정

SSH 서명 키

classes.js

Searches for query terms inside of a file. This method returns up to 100 results <a href="https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for code, you can get text match metadata for the file content and file path fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the definition of the <code>addClass</code> function inside <a href="https://github.com/jquery/jquery">jQuery</a> repository, your query would look something like this:
<code>q=addClass+in:file+language:js+repo:jquery/jquery</code>
This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.
Considerations for code search:
Due to the complexity of searching code, there are a few restrictions on how searches are performed:
<ul>
<li>Only the default branch is considered. In most cases, this will be the <code>master</code> branch.</li>
<li>Only files smaller than 384 KB are searchable.</li>
<li>You must always include at least one search term when searching source code. For example, searching for <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=language%3Ago&#x26;type=Code"><code>language:go</code></a> is not valid, while <a href="https://github.com/search?utf8=%E2%9C%93&#x26;q=amazing+language%3Ago&#x26;type=Code"><code>amazing language:go</code></a> is.</li>
</ul>

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-code">Searching code</a>" for a detailed list of qualifiers.

Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results">best match</a>

sort

Determines whether the first search result returned is the highest number of matches (<code>desc</code>) or lowest number of matches (<code>asc</code>). This parameter is ignored unless you provide <code>sort</code>.

order

The number of results per page (max 100). For more information, see "<a href="https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

per_page

The page number of the results to fetch. For more information, see "<a href="https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

page

Validation failed, or the endpoint has been spammed.

Search code

Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href="https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for commits, you can get text match metadata for the message field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata">Text match
metadata</a>.
For example, if you want to find commits related to CSS in the <a href="https://github.com/octocat/Spoon-Knife">octocat/Spoon-Knife</a> repository. Your query would look something like this:
<code>q=repo:octocat/Spoon-Knife+css</code>

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-commits">Searching commits</a>" for a detailed list of qualifiers.

Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results">best match</a>

Search commits

Line Number Indexes Beyond 20 Not Displayed

Find issues by state and keyword. This method returns up to 100 results <a href="https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api">per page</a>.
When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted
search results, see <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata">Text match metadata</a>.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
<code>q=windows+label:bug+language:python+state:open&#x26;sort=created&#x26;order=asc</code>
This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.
<div class="ghd-alert ghd-alert-accent"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon mr-2" aria-hidden><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>Note

For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see "<a href="https://docs.github.com/enterprise-server@3.15/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests">Searching only issues or pull requests</a>."
</div>

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href="https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query">Constructing a search query</a>. See "<a href="https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-issues-and-pull-requests">Searching issues and pull requests</a>" for a detailed list of qualifiers.

Search issues and pull requests