GitHub Actions 관리 API 가이드 (v1.2)

GIIP 플랫폼은 GitHub 저장소의 워크플로우 실행 이력을 관리하고 모니터링하기 위한 API를 제공합니다.

🔌 GitHub 연동 기능 페이지로 이동 →

📋 개요

GitHub Actions 관리 API는 등록된 저장소의 최신 워크플로우 상태를 동기화하고, 장애 발생 시 GIIP 콘솔에서 즉시 확인할 수 있도록 데이터를 제공합니다.

🔐 인증 및 보안

• Header: 공통 x-giip-ak / x-giip-sk 헤더 필수
• Token:

  githubToken

  은 GitHub Personal Access Token(Classic 또는 Fine-grained)을 사용해야 합니다.

📡 API 상세 (Sk3)

1. GitHub 설정 목록 조회 (GitHubConfigsList)

• 명령:

  text=GitHubConfigsList

• jsondata:

  {"csn": 123}

  (선택 사항)
• 설명: 프로젝트별 GitHub 연동 설정 정보를 반환합니다.

2. GitHub 설정 생성 (GitHubConfigCreate)

• 명령:

  text=GitHubConfigCreate

• jsondata:

{
  "csn": 123,
  "configName": "Backend Repo",
  "repoOwner": "org-name-or-user",
  "repoName": "repo-name",
  "githubToken": "ghp_..."
}

3. 워크플로우 실행 이력 조회 (GitHubWorkflowRunsList)

• 명령:

  text=GitHubWorkflowRunsList

• jsondata:

  {"gcId": 123, "perPage": 20, "status": "all"}

• 설명: 특정 연동 설정(gcId)에 대한 GitHub Actions 실행 이력을 조회합니다.

🛡️ Sk3(고성능 로깅) 활용

GitHub Personal Access Token과 같은 민감한 정보를 다루는 설정 생성 및 워크플로우 동기화 작업 시

giipApiSk3

엔드포인트를 권장합니다.

• 엔드포인트:

  https://giipfaw.azurewebsites.net/api/giipApiSk3

• 보안 장점:

  githubToken

  유출 시도나 비정상적인 호출 패턴을 자동으로 기록하고, 에러 발생 시 상세한 컨텍스트(Stacktrace)를 제공하여 신속하게 대응할 수 있습니다.
• 활용 팁:

  text

  명령과

  jsondata

  의 파라미터 치환 기능을 활용하여 워크플로우 조회 조건(perPage, status 등)을 코드 수준에서 안전하게 관리하십시오.

---

버전: 1.3 최종 업데이트: 2026-04-10 소스 파일:

giipv3/public/help/api-github.ko.md

---

관련 문서:

• API 결과 코드 가이드 (RstVal)