백엔드 서비스가 관리 작업을 자동화하려면 Admin UI에서 System-to-System API 키를 발급하고 필요한 권한을 선택하세요. 그다음 X-API-Key 헤더로 기존 /api를 호출하면 됩니다. 키를 발급하기 위한 별도의 API 호출은 필요하지 않습니다.
1. Admin UI에서 키 발급
- 보안 설정을 수정할 수 있는 관리자로 Admin UI에 로그인합니다.
- Runtime → Management API Keys 페이지를 엽니다.
production-integration같은 이름과 만료 시간을 입력합니다.- 필요한 권한을 선택합니다. 아래 예시는
/runtime/db-management.view와/runtime/custom-tools.view가 필요합니다. - Issue key를 누르고 한 번만 표시되는 비밀 값을 복사합니다.
키는 백엔드 Secret Manager 또는 환경 변수에 보관하고 브라우저나 Git에 노출하지 마세요.
2. 기존 관리 API 호출
설정된 데이터베이스 연결 목록:
curl -X GET "https://agent.example.com/api/DbManagement" \
-H "X-API-Key: ${HS_MANAGEMENT_API_KEY}"Custom Tools 목록:
curl -X GET "https://agent.example.com/api/CustomSqlTool" \
-H "X-API-Key: ${HS_MANAGEMENT_API_KEY}"3. 응답 확인
데이터베이스 목록 API는 성공 시 HTTP 200과 JSON 배열을 반환합니다. 아래는 한 항목의 일부 필드 예시입니다.
[
{
"id": 1,
"name": "Production DB",
"sqlProvider": "PostgreSql",
"host": "db.internal",
"database": "orders",
"isBootstrapManaged": false
}
]키 권한과 호출 가능한 API
Admin UI에서 부여한 권한에 따라 동일한 키로 여러 기존 관리 API를 호출할 수 있습니다.
| API | Permission |
|---|---|
GET /api/DbManagement | /runtime/db-management.view |
GET /api/CustomSqlTool | /runtime/custom-tools.view |
POST /api/CustomSqlTool | /runtime/custom-tools.create |
POST /api/CustomSqlTool/{id}/publish | /runtime/custom-tools.edit |
POST /api/DbManagement | /runtime/db-management.create |
Request／Response 확인
POST JSON 예시는실제 요청과 응답을, 다른 경로는관리 REST API 목록을 참고하세요. 부족한 응답 Schema는 Issue #295에서 보완 중입니다.
키 교체 또는 폐기
키의 교체나 폐기는 Runtime → Management API Keys에서 처리합니다. 외부 서비스는 이미 발급된 키만 사용하면 됩니다.