REST API 리소스
Tier: Free, Premium, Ultimate
Offering: GitLab.com, Self-managed, GitLab Dedicated
GitLab REST API를 위한 사용 가능한 리소스는 다음과 같은 컨텍스트로 그룹화될 수 있습니다.
참고:
프로젝트 리소스
다음과 같은 API 리소스가 프로젝트 컨텍스트에서 사용할 수 있습니다:
리소스 | 사용 가능한 엔드포인트 |
---|---|
접근 요청 |
/projects/:id/access_requests (그룹에서도 사용 가능)
|
액세스 토큰 |
/projects/:id/access_tokens (그룹에서도 사용 가능)
|
에이전트 | /projects/:id/cluster_agents
|
브랜치 |
/projects/:id/repository/branches/ , /projects/:id/repository/merged_branches
|
커밋 |
/projects/:id/repository/commits , /projects/:id/statuses
|
컨테이너 레지스트리 | /projects/:id/registry/repositories
|
사용자 정의 속성 |
/projects/:id/custom_attributes (그룹 및 사용자에서도 사용 가능)
|
Composer 배포 |
/projects/:id/packages/composer (그룹에서도 사용 가능)
|
Conan 배포 |
/projects/:id/packages/conan (독립형에서도 사용 가능)
|
데비안 배포 |
/projects/:id/debian_distributions (그룹에서도 사용 가능)
|
데비안 패키지 |
/projects/:id/packages/debian (그룹에서도 사용 가능)
|
의존성 | /projects/:id/dependencies
|
배포 키 |
/projects/:id/deploy_keys (독립형에서도 사용 가능)
|
배포 토큰 |
/projects/:id/deploy_tokens (그룹 및 독립형에서도 사용 가능)
|
배포 | /projects/:id/deployments
|
코멘트 | /projects/:id/merge_requests/.../draft_notes
|
이모지 반응 |
/projects/:id/issues/.../award_emoji , /projects/:id/merge_requests/.../award_emoji , /projects/:id/snippets/.../award_emoji
|
환경 | /projects/:id/environments
|
에러 추적 | /projects/:id/error_tracking/settings
|
이벤트 |
/projects/:id/events (사용자 및 독립형에서도 사용 가능)
|
외부 상태 확인 | /projects/:id/external_status_checks
|
기능 플래그 사용자 목록 | /projects/:id/feature_flags_user_lists
|
기능 플래그 | /projects/:id/feature_flags
|
동결 기간 | /projects/:id/freeze_periods
|
Go Proxy | /projects/:id/packages/go
|
Helm 저장소 | /projects/:id/packages/helm_repository
|
통합 | /projects/:id/integrations
|
초대 |
/projects/:id/invitations (그룹에서도 사용 가능)
|
이슈 보드 | /projects/:id/boards
|
이슈 링크 | /projects/:id/issues/.../links
|
이슈 통계 |
/projects/:id/issues_statistics (그룹 및 독립형에서도 사용 가능)
|
이슈 |
/projects/:id/issues (그룹 및 독립형에서도 사용 가능)
|
이터레이션 |
/projects/:id/iterations (그룹에서도 사용 가능)
|
프로젝트 CI/CD 작업 토큰 범위 | /projects/:id/job_token_scope
|
작업 |
/projects/:id/jobs , /projects/:id/pipelines/.../jobs
|
작업 아티팩트 | /projects/:id/jobs/:job_id/artifacts
|
라벨 | /projects/:id/labels
|
Maven 저장소 |
/projects/:id/packages/maven (그룹 및 독립형에서도 사용 가능)
|
멤버 |
/projects/:id/members (그룹에서도 사용 가능)
|
병합 요청 승인 |
/projects/:id/approvals , /projects/:id/merge_requests/.../approvals
|
병합 요청 |
/projects/:id/merge_requests (그룹 및 독립형에서도 사용 가능)
|
병합 트레인 | /projects/:id/merge_trains
|
메타데이터 | /metadata
|
모델 레지스트리 | /projects/:id/packages/ml_models/
|
노트 |
/projects/:id/issues/.../notes , /projects/:id/snippets/.../notes , /projects/:id/merge_requests/.../notes (그룹에서도 사용 가능)
|
알림 설정 |
/projects/:id/notification_settings (그룹 및 독립형에서도 사용 가능)
|
NPM 저장소 | /projects/:id/packages/npm
|
NuGet 패키지 |
/projects/:id/packages/nuget (그룹에서도 사용 가능)
|
패키지 | /projects/:id/packages
|
페이지 도메인 |
/projects/:id/pages/domains (독립형에서도 사용 가능)
|
페이지 설정 | /projects/:id/pages
|
파이프라인 일정 | /projects/:id/pipeline_schedules
|
파이프라인 트리거 | /projects/:id/triggers
|
파이프라인 | /projects/:id/pipelines
|
프로젝트 뱃지 | /projects/:id/badges
|
프로젝트 클러스터 | /projects/:id/clusters
|
프로젝트 가져오기/내보내기 |
/projects/:id/export , /projects/import , /projects/:id/import
|
프로젝트 마일스톤 | /projects/:id/milestones
|
프로젝트 스니펫 | /projects/:id/snippets
|
프로젝트 템플릿 | /projects/:id/templates
|
프로젝트 취약점. | /projects/:id/vulnerabilities
|
프로젝트 위키 | /projects/:id/wikis
|
프로젝트 수준 변수 | /projects/:id/variables
|
프로젝트 웹훅 설정 포함 |
/projects , /projects/:id/hooks (사용자에서도 사용 가능)
|
보호된 브랜치 | /projects/:id/protected_branches
|
보호된 컨테이너 레지스트리 | /projects/:id/registry/protection/rules
|
보호된 환경 | /projects/:id/protected_environments
|
보호된 패키지 | /projects/:id/packages/protection/rules
|
보호된 태그 | /projects/:id/protected_tags
|
PyPI 패키지 |
/projects/:id/packages/pypi (그룹에서도 사용 가능)
|
릴리스 링크 | /projects/:id/releases/.../assets/links
|
릴리스 | /projects/:id/releases
|
원격 미러 | /projects/:id/remote_mirrors
|
리포지토리 | /projects/:id/repository
|
리포지토리 파일 | /projects/:id/repository/files
|
리포지토리 서브모듈 | /projects/:id/repository/submodules
|
리소스 라벨 이벤트 |
/projects/:id/issues/.../resource_label_events , /projects/:id/merge_requests/.../resource_label_events (그룹에서도 사용 가능)
|
루비 젬 | /projects/:id/packages/rubygems
|
런너 |
/projects/:id/runners (독립형에서도 사용 가능)
|
검색 |
/projects/:id/search (그룹 및 독립형에서도 사용 가능)
|
태그 | /projects/:id/repository/tags
|
테라폼 모듈 |
/projects/:id/packages/terraform/modules (독립형에서도 사용 가능)
|
취약점 | /vulnerabilities/:id
|
취약점 내보내기 | /projects/:id/vulnerability_exports
|
취약점 결과 | /projects/:id/vulnerability_findings
|
그룹 리소스
다음 API 리소스는 그룹 컨텍스트에서 사용할 수 있습니다.
Resource | Available endpoints |
---|---|
Access requests |
/groups/:id/access_requests/ (프로젝트에서도 사용 가능)
|
Access tokens |
/groups/:id/access_tokens (프로젝트에서도 사용 가능)
|
Custom attributes |
/groups/:id/custom_attributes (프로젝트 및 사용자에서도 사용 가능)
|
Debian distributions |
/groups/:id/-/packages/debian (프로젝트에서도 사용 가능)
|
Deploy tokens |
/groups/:id/deploy_tokens (프로젝트 및 독립형으로도 사용 가능)
|
Discussions (comments and threads) |
/groups/:id/epics/.../discussions (프로젝트에서도 사용 가능)
|
Epic issues | /groups/:id/epics/.../issues
|
Epic links | /groups/:id/epics/.../epics
|
Epics | /groups/:id/epics
|
Groups |
/groups , /groups/.../subgroups
|
Group badges | /groups/:id/badges
|
Group issue boards | /groups/:id/boards
|
Group iterations |
/groups/:id/iterations (프로젝트에서도 사용 가능)
|
Group labels | /groups/:id/labels
|
Group-level variables | /groups/:id/variables
|
Group milestones | /groups/:id/milestones
|
Group releases | /groups/:id/releases
|
Group SSH certificates | /groups/:id/ssh_certificates
|
Group wikis | /groups/:id/wikis
|
Invitations |
/groups/:id/invitations (프로젝트에서도 사용 가능)
|
Issues |
/groups/:id/issues (프로젝트 및 독립형에서도 사용 가능)
|
Issues Statistics |
/groups/:id/issues_statistics (프로젝트 및 독립형에서도 사용 가능)
|
Linked epics | /groups/:id/epics/.../related_epics
|
Member Roles | /groups/:id/member_roles
|
Members |
/groups/:id/members (프로젝트에서도 사용 가능)
|
Merge requests |
/groups/:id/merge_requests (프로젝트 및 독립형에서도 사용 가능)
|
Notes (comments) |
/groups/:id/epics/.../notes (프로젝트에서도 사용 가능)
|
Notification settings |
/groups/:id/notification_settings (프로젝트 및 독립형에서도 사용 가능)
|
Resource label events |
/groups/:id/epics/.../resource_label_events (프로젝트에서도 사용 가능)
|
Search |
/groups/:id/search (프로젝트 및 독립형에서도 사용 가능)
|
독립형 리소스
다음 API 리소스는 프로젝트 및 그룹 컨텍스트 이외의 외부에서 사용할 수 있습니다 (/users
포함):
Resource | Available endpoints |
---|---|
Appearance | /application/appearance
|
Applications | /applications
|
Audit events | /audit_events
|
Avatar | /avatar
|
Broadcast messages | /broadcast_messages
|
Code snippets | /snippets
|
Code Suggestions | /code_suggestions
|
Custom attributes |
/users/:id/custom_attributes (그룹 및 프로젝트에서도 사용 가능)
|
Dependency list exports |
/pipelines/:id/dependency_list_exports , /projects/:id/dependency_list_exports , /groups/:id/dependency_list_exports , /security/dependency_list_exports/:id , /security/dependency_list_exports/:id/download
|
Deploy keys |
/deploy_keys (프로젝트에서도 사용 가능)
|
Deploy tokens |
/deploy_tokens (프로젝트 및 그룹에서도 사용 가능)
|
Events |
/events , /users/:id/events (프로젝트에서도 사용 가능)
|
Feature flags | /features
|
Geo Nodes | /geo_nodes
|
Group Activity Analytics | /analytics/group_activity/{issues_count}
|
Group repository storage moves | /group_repository_storage_moves
|
Import repository from GitHub | /import/github
|
Import repository from Bitbucket Server | /import/bitbucket_server
|
Instance clusters | /admin/clusters
|
Instance-level CI/CD variables | /admin/ci/variables
|
Issues Statistics |
/issues_statistics (그룹 및 프로젝트에서도 사용 가능)
|
Issues |
/issues (그룹 및 프로젝트에서도 사용 가능)
|
Jobs | /job
|
Keys | /keys
|
License | /license
|
Markdown | /markdown
|
Merge requests |
/merge_requests (그룹 및 프로젝트에서도 사용 가능)
|
Namespaces | /namespaces
|
Notification settings |
/notification_settings (그룹 및 프로젝트에서도 사용 가능)
|
Pages domains |
/pages/domains (프로젝트에서도 사용 가능)
|
Personal access tokens | /personal_access_tokens
|
Plan limits | /application/plan_limits
|
Project repository storage moves | /project_repository_storage_moves
|
Projects |
/users/:id/projects (프로젝트에서도 사용 가능)
|
Runners |
/runners (프로젝트에서도 사용 가능)
|
Search |
/search (그룹 및 프로젝트에서도 사용 가능)
|
Service Data |
/usage_data (GitLab 인스턴스 관리자 전용)
|
Settings | /application/settings
|
Sidekiq metrics | /sidekiq
|
Sidekiq queues administration | /admin/sidekiq/queues/:queue_name
|
Snippet repository storage moves | /snippet_repository_storage_moves
|
Statistics | /application/statistics
|
Suggestions | /suggestions
|
System hooks | /hooks
|
To-dos | /todos
|
Token information | /admin/token
|
Topics | /topics
|
Users | /users
|
Validate .gitlab-ci.yml file
| /lint
|
Web commits | /web_commits/public_key
|
Version | /version
|
템플릿 API 리소스
다음과 같은 엔드포인트를 통해 사용할 수 있습니다:
- Dockerfile 템플릿
.gitignore
템플릿- GitLab CI/CD YAML 템플릿](templates/gitlab_ci_ymls.md)
- 오픈 소스 라이선스 템플릿](templates/licenses.md)