external-sources
external-sources API, 8 endpoints (generated)
GET /api/v1/external-sources
GET/api/v1/external-sources
외부 데이터 소스 목록
이 테넌트에 등록된 외부 데이터 소스를 반환합니다.
Permission: VIEW
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
POST /api/v1/external-sources
POST/api/v1/external-sources
외부 데이터 소스 등록
외부 데이터 소스를 등록합니다.
Permission: DATASET_WRITE
Request body: application/json, SourceCreate
| Field | Type | Required | Description |
|---|---|---|---|
name | string | ✓ | 표시명 |
base_url | string | ✓ | 3종 엔드포인트가 매달리는 기준 URL (예: https://host/api) |
token | string? | Token | |
description | string? | Description | |
enabled | boolean | Enabled |
Responses
| Status | Description |
|---|---|
| 201 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/external-sources/{source_id}
GET/api/v1/external-sources/{source_id}
외부 데이터 소스 상세
단일 소스의 설정을 반환합니다 (VIEW 권한, 토큰 마스킹).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
source_id | path | string | ✓ |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
PATCH /api/v1/external-sources/{source_id}
PATCH/api/v1/external-sources/{source_id}
외부 데이터 소스 수정
소스 설정을 수정합니다.
Permission: DATASET_WRITE
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
source_id | path | string | ✓ |
Request body: application/json, SourceUpdate
| Field | Type | Required | Description |
|---|---|---|---|
name | string? | Name | |
base_url | string? | Base Url | |
token | string? | Token | |
description | string? | Description | |
enabled | boolean? | Enabled |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
DELETE /api/v1/external-sources/{source_id}
DELETE/api/v1/external-sources/{source_id}
외부 데이터 소스 삭제
소스를 삭제합니다.
Permission: DATASET_WRITE
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
source_id | path | string | ✓ | |
force | query | boolean |
Responses
| Status | Description |
|---|---|
| 204 | Successful Response |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/external-sources/{source_id}:test
POST/api/v1/external-sources/{source_id}:test
연결 확인
원격 목록을 1건만 조회해 연결·인증을 확인합니다.
Permission: DATASET_WRITE
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
source_id | path | string | ✓ |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/external-sources/{source_id}/remote-datasets
GET/api/v1/external-sources/{source_id}/remote-datasets
원격 데이터셋 목록
원격 서버의 데이터셋 목록을 대신 조회해 반환합니다.
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
source_id | path | string | ✓ | |
updated_after | query | string (date-time)? | ||
page | query | integer | ||
page_size | query | integer? |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/external-sources/{source_id}/remote-datasets/{remote_dataset_id}/manifest
GET/api/v1/external-sources/{source_id}/remote-datasets/{remote_dataset_id}/manifest
원격 매니페스트 · 동기화 미리보기
원격 매니페스트(파일 목록 + sha256)를 반환합니다.
Permission: VIEW
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
source_id | path | string | ✓ | |
remote_dataset_id | path | string | ✓ | |
dataset_id | query | string? |
Responses
| Status | Description |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |