API Reference

전체 엔드포인트를 리소스별로 정리했습니다. 파라미터·본문·응답 스키마는 Swagger에서 실행하며 확인하세요.

Auth

메서드	경로	설명
POST	`/api/auth/login`	사용자 로그인
POST	`/api/auth/generate-key`	API 키 생성
GET	`/api/auth/logout`	로그아웃
GET	`/api/auth/get-token`	토큰 조회
PUT	`/api/auth/update-account`	계정 정보 수정
GET	`/api/auth/me`	현재 사용자 조회
GET	`/api/auth/authenticators`	인증 수단 조회
POST	`/api/auth/login-device/check`	로그인 장비 확인

Health Check

메서드	경로	설명
GET	`/healthCheck/`	종합 헬스체크
GET	`/healthCheck/redis`	Redis 상태
GET	`/healthCheck/mysql`	MySQL 상태
GET	`/healthCheck/storage`	스토리지 상태

License

메서드	경로	설명
GET	`/api/license/get-license-info`	라이선스 정보 조회

Device

메서드	경로	설명
GET	`/api/device`	전체 장비 목록
POST	`/api/device/add`	스토리지(S3 등 오브젝트 스토리지) 등록
POST	`/api/device/install`	설치파일 다운로드
POST	`/api/device/validate-device-before-install`	설치 전 검증
POST	`/api/device/checkOutbound`	아웃바운드 확인
POST	`/api/device/checkConnection`	연결 확인
POST	`/api/device/invite-user-to-device`	사용자 초대
POST	`/api/device/share-device-by-mail`	메일로 장비 공유
GET	`/api/device/get-device-share-list`	공유 목록 조회
GET	`/api/device/connectivity/{deviceId}`	연결 상태 조회
GET	`/api/device/{device_id}/detail`	상세 정보 조회
GET	`/api/device/exist-automation/{deviceId}`	자동화 존재 여부
GET	`/api/device/total-file-and-size-on-path/{deviceId}`	경로 파일 수·용량
GET	`/api/device/hyperlink`	하이퍼링크 조회
POST	`/api/device/checkHyperlinkInfo`	하이퍼링크 정보 확인
POST	`/api/device/setHyperlink`	하이퍼링크 설정
GET	`/api/device/scenario-speed`	시나리오 속도
GET	`/api/device/get-user-path-permission`	경로 권한 조회
GET	`/api/device/{deviceId}/registered-users`	등록 사용자 목록
DELETE	`/api/device/{deviceId}/registered-users/{userId}`	등록 사용자 삭제
PATCH	`/api/device/restart/{deviceId}`	장비 재시작
PATCH	`/api/device/updateAgent/{deviceId}`	에이전트 업데이트
PATCH	`/api/device/{device_id}`	장비 정보 업데이트
DELETE	`/api/device/{device_id}`	장비 삭제

Groups

메서드	경로	설명
GET	`/api/group`	그룹 목록
POST	`/api/group`	그룹 생성
POST	`/api/group/moveDevice`	장비 이동
PATCH	`/api/group/{groupId}`	그룹 업데이트
DELETE	`/api/group/{groupId}`	그룹 삭제

Data Set (Hot Folder)

메서드	경로	설명
GET	`/api/hot-folder`	목록 조회
POST	`/api/hot-folder`	생성
GET	`/api/hot-folder/{id}`	상세 조회
PATCH	`/api/hot-folder/{id}`	업데이트
DELETE	`/api/hot-folder/{id}`	삭제
PUT	`/api/hot-folder/group/{groupId}`	그룹 지정
DELETE	`/api/hot-folder/group/{groupId}`	그룹 해제
DELETE	`/api/hot-folder/delete-many`	다중 삭제

File Explorer

메서드	경로	설명
POST	`/api/explorer/fileSearchV1/{deviceId}`	경로 탐색
POST	`/api/explorer/fileSearchV3/{deviceId}`	경로 탐색
POST	`/api/explorer/createFolder/{deviceId}`	폴더 생성
POST	`/api/explorer/removeFile/{deviceId}`	파일 삭제
POST	`/api/explorer/renameFile/{deviceId}`	이름 변경
POST	`/api/explorer/copyFile/{deviceId}`	복사
POST	`/api/explorer/cutFile/{deviceId}`	잘라내기
POST	`/api/explorer/cancelSearch/{deviceId}`	탐색 취소

Transfer

메서드	경로	설명
POST	`/api/transfer`	전송 생성
POST	`/api/transfer/manualTransfer`	1회성 전송 생성
GET	`/api/transfer/{id}/get-files`	전송 파일 목록
GET	`/api/transfer/total-folder/{monitorId}`	총 폴더 수
GET	`/api/transfer/recursive-file-by-folder/{monitorId}`	폴더별 재귀 파일
GET	`/api/transfer/{monitorId}/automation-detail`	자동화 상세
POST	`/api/transfer/{monitorId}/replay`	재실행
PATCH	`/api/transfer/queue-priority/{monitorId}`	큐 우선순위 변경
PATCH	`/api/transfer/pause/{monitorId}`	일시 중지
PATCH	`/api/transfer/cancel/{monitorId}`	취소
PATCH	`/api/transfer/resume/{monitorId}`	재개
POST	`/api/transfer/retry-failed-files`	실패 파일 재시도
POST	`/api/transfer/check-queue`	큐 확인
POST	`/api/transfer/validation/path`	경로 검증
POST	`/api/transfer/scenario-speed`	시나리오 속도
GET	`/api/transfer/{id}/status`	전송 상태 조회
GET	`/api/transfer/{device}/status`	장비 전송 상태 조회

Automation

메서드	경로	설명
POST	`/api/automation`	자동화 생성
GET	`/api/automation`	목록 조회
GET	`/api/automation/{automationId}`	상세 조회
GET	`/api/automation/{automationId}/details`	세부 정보
PATCH	`/api/automation/{automationId}`	업데이트
DELETE	`/api/automation/{automationId}`	삭제
POST	`/api/automation/checkValidDevicePath`	장비 경로 유효성
GET	`/api/automation/generateAutomationName`	이름 자동 생성
GET	`/api/automation/next-schedule/{automationDetailId}`	다음 스케줄 조회
PATCH	`/api/automation/next-schedule/{automationDetailId}`	다음 스케줄 변경
POST	`/api/automation/pause`	자동화 일시중지

Flow (Automation Component)

메서드	경로	설명
POST	`/api/automation-component`	플로우 생성
GET	`/api/automation-component`	목록 조회
GET	`/api/automation-component/{componentId}`	상세 조회
GET	`/api/automation-component/automation-detail/{automationDetailId}`	자동화 상세 기준 조회
PATCH	`/api/automation-component/{componentId}`	업데이트
DELETE	`/api/automation-component/{componentId}`	삭제

Monitoring (Transfer History)

메서드	경로	설명
GET	`/api/transfer-history`	전체 이력
GET	`/api/transfer-history/{id}/detail`	상세 상태
GET	`/api/transfer-history/{id}/get-files`	파일 목록
GET	`/api/transfer-history/{monitorId}/automation-detail`	자동화 상세
GET	`/api/transfer-history/{monitorId}/files-recursive`	재귀 파일 목록
GET	`/api/transfer-history/export-csv`	CSV 내보내기

Policy & Permission

메서드	경로	설명
GET	`/api/policy-management`	정책 목록
PUT	`/api/policy-management/{policyManagementId}`	정책 업데이트
GET	`/api/policy-management/{policyManagementId}/restricted-file`	제한 파일 조회
GET	`/api/policy-management/{policyManagementId}/user-access`	접근 사용자 조회
POST	`/api/policy-management/{policyManagementId}/user-access`	접근 추가
PUT	`/api/policy-management/{policyManagementId}/user-access`	접근 수정
DELETE	`/api/policy-management/{policyManagementId}/user-access`	접근 삭제
GET	`/api/policy-management/{policyManagementId}/user-access/search`	접근 검색
POST	`/api/permission/path`	경로 권한 생성
PATCH	`/api/permission/path/{pathId}`	경로 권한 수정
PATCH	`/api/permission/path/{pathId}/permission`	권한 값 수정
DELETE	`/api/permission/path/{pathId}`	경로 권한 삭제

Security Policy

메서드	경로	설명
GET	`/api/security-policy`	조회
POST	`/api/security-policy`	생성
PUT	`/api/security-policy`	수정
POST	`/api/security-policy/check-transfer-valid`	전송 유효성 검사

Integration

메서드	경로	설명
GET	`/api/integration`	목록 조회
POST	`/api/integration`	생성
PUT	`/api/integration/{id}`	수정
DELETE	`/api/integration/{id}`	삭제
GET	`/api/integration/rules/{type}`	유형별 규칙 조회

Access History

메서드	경로	설명
GET	`/api/access-history`	접근 이력 조회
GET	`/api/access-history/export-csv`	CSV 내보내기

Notification

메서드	경로	설명
GET	`/api/notification`	알림 목록 조회

User

메서드	경로	설명
GET	`/api/user/me`	내 정보
GET	`/api/user/get-by-workspace/{workSpaceId}`	워크스페이스 사용자
GET	`/api/user/search-user-by-workspace/{workSpaceId}`	사용자 검색
GET	`/api/user/sub-user`	서브 사용자 목록
GET	`/api/user/sub-user/{userId}`	서브 사용자 조회
POST	`/api/user/sub-user/update-sub-user`	서브 사용자 수정
DELETE	`/api/user/remove-sub-user`	서브 사용자 삭제

WorkSpace

메서드	경로	설명
POST	`/api/workSpace`	생성
GET	`/api/workSpace/{workSpaceId}`	조회
PUT	`/api/workSpace/{workSpaceId}`	수정
DELETE	`/api/workSpace/{workSpaceId}`	삭제
POST	`/api/workSpace/user/{workSpaceId}`	사용자 추가
GET	`/api/workSpace/switch/{workSpaceId}`	워크스페이스 전환
PATCH	`/api/workSpace/update-permission/{workSpaceId}`	권한 수정
DELETE	`/api/workSpace/remove-user/{workSpaceId}`	사용자 제거
PATCH	`/api/workSpace/leave/{workSpaceId}`	워크스페이스 나가기