digna REST API 2026.11¶

digna REST API를 사용하면 자체 도구와 파이프라인이 HTTP와 JSON으로 digna와 연동할 수 있습니다. 프로젝트와 검사 결과를 읽고, 데이터 소스·데이터 세트·속성을 관리하고, 예를 들어 데이터 적재가 끝날 때 검사를 시작할 수 있습니다. Python SDK도 같은 API를 사용합니다.

이 페이지에서는 모든 요청에 공통되는 내용을 다룹니다. 리소스 페이지에는 각 엔드포인트의 매개변수, 요청 본문, 응답, 스키마가 정리되어 있습니다.

기본 URL¶

이 API는 digna 백엔드의 일부입니다. 모든 경로는 백엔드 주소 뒤에 /v1로 시작합니다.

https://digna.example.com/v1/projects

백엔드 주소는 대시보드가 사용하는 주소와 같으며, dashboard/dashboard_config.toml의 [api] 섹션에 있는 baseUrl입니다. 모든 요청에 API 키가 담기므로, 호출하는 쪽과 digna가 같은 머신에 있지 않다면 항상 HTTPS를 사용하세요.

인증¶

모든 요청은 digna 사용자의 API 키를 Authorization 헤더에 담아 보냅니다.

Authorization: Bearer <api key>

키를 만들려면 대시보드 왼쪽 아래에서 사용자 프로필을 열고 API Keys, 이어서 Add API Key를 클릭한 뒤 키를 복사합니다. 키는 한 번만 표시됩니다. 같은 키를 digna MCP Server에서도 사용할 수 있습니다.

요청은 키 소유 사용자의 권한으로 실행됩니다. 생성, 변경, 삭제에는 해당 프로젝트의 editor 역할이 필요하며, 그렇지 않으면 요청이 403과 메시지 You don't have permission to edit this project로 거부됩니다.

요청 보내기¶

export DIGNA_API_KEY='<api key>'
curl https://digna.example.com/v1/projects -H "Authorization: Bearer $DIGNA_API_KEY"

응답은 JSON입니다. 목록은 JSON 배열로 반환됩니다. 요청 본문도 JSON이며 Content-Type: application/json과 함께 보냅니다.

한도와 필터¶

목록 엔드포인트는 최대 limit개의 항목을 반환합니다. 기본값은 200개이고 최대 5000개까지 가능합니다. 이 범위를 벗어난 값은 400으로 거부됩니다. 오프셋이나 페이지 토큰이 없으므로, 대신 목록의 필터로 범위를 좁히세요. 예를 들어 project_id, data_source_id, 또는 검사 상태의 경우 start_date와 end_date를 사용합니다.

60초보다 오래 걸리는 요청은 408 Request Timeout으로 취소됩니다.

오류¶

오류 응답에는 코드와 메시지가 담긴 JSON 본문이 있습니다.

{
  "code": "NOT_FOUND",
  "message": "Data set not found"
}

401의 message는 키에 어떤 문제가 있는지 알려 줍니다.

검사 실행¶

일반적인 통합은 데이터 적재가 끝나면 검사를 시작하고, 검사가 끝날 때까지 기다린 다음 결과를 읽습니다.

1. POST /v1/inspection-requests로 검사를 시작합니다. 응답에는 요청의 id가 들어 있습니다.
2. GET /v1/inspection-requests/{inspection_request_id}로 진행 상황을 추적합니다. status는 PENDING에서 RUNNING을 거쳐 COMPLETED로 바뀌거나, FAILED, ABORTED 또는 CANCELLED로 끝납니다. 값이 더 이상 바뀌지 않을 때까지 몇 초마다 다시 조회하세요.
3. 검사한 날짜에 대해 GET /v1/inspection-statuses/data-sources로 결과를 읽습니다. 각 항목에는 전체 status로 0(OK), 1(경고), 2(심각) 또는 -1(상태 없음)이 있고, 모듈별 상태와 함께 통과, 불확실, 실패한 검사 수가 포함됩니다.

curl -X POST https://digna.example.com/v1/inspection-requests \
  -H "Authorization: Bearer $DIGNA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "project_id": 1,
    "include_all_data_sources": true,
    "data_source_ids": [],
    "start_date": "2026-11-06",
    "end_date": "2026-11-06",
    "mode": "DAILY",
    "weekly_mode_weekdays": [],
    "monthly_mode_days": [],
    "use_notification": true
  }'

OpenAPI 문서¶

모든 digna 설치는 이 API를 OpenAPI 3.1 문서로 설명하며, 이를 대상으로 요청을 시험해 볼 수 있는 대화형 Swagger UI를 제공합니다.

Release 2026.11의 문서는 여기에서도 받을 수 있습니다: openapi.json. 이 문서로 다른 언어의 클라이언트를 생성할 수 있습니다.