본문으로 바로가기
본문으로 바로가기

API 참조

ClickStack은 대시보드, 알림, 데이터 소스를 프로그램으로 관리할 수 있는 REST API를 제공합니다. 이 API는 Managed ClickStack(ClickHouse Cloud)과 ClickStack Open Source 배포 모두에서 사용할 수 있지만, 두 환경 간에 엔드포인트와 인증 방식이 다릅니다.

API 참조 문서​

Managed ClickStack의 경우 API는 ClickHouse Cloud API를 통해 사용할 수 있습니다. ClickStack 엔드포인트는 Cloud API 명세에서 확인할 수 있습니다.

다음 엔드포인트를 제공합니다:

리소스작업
Dashboards대시보드 생성, 목록 조회, 조회, 업데이트 및 삭제
Alerts알림 생성, 목록 조회, 조회, 업데이트 및 삭제
Sources데이터 소스 목록 조회

인증​

Managed ClickStack는 HTTP Basic Authentication을 통해 인증을 수행하기 위해 ClickHouse Cloud API key를 사용합니다. API key를 생성하고 관리하는 방법은 Managing API keys를 참조하십시오.

HTTP Basic Authentication을 사용하여 key ID와 secret을 포함하십시오:

export KEY_ID=<your_key_id>
export KEY_SECRET=<your_key_secret>

curl --user $KEY_ID:$KEY_SECRET \
  https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/dashboards

기본 URL 및 요청 형식​

모든 Managed ClickStack API 요청은 ClickHouse Cloud API로 전송됩니다:

https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/<resource>

Organization ID는 ClickHouse Cloud 콘솔의 Organization → Organization details 메뉴에서 확인할 수 있습니다. Service ID는 서비스 URL 또는 서비스 세부 정보 페이지에서 확인할 수 있습니다.

예시: 대시보드 목록 조회​

curl --user $KEY_ID:$KEY_SECRET \
  https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/dashboards

예시: 알림 생성​

curl -X POST --user $KEY_ID:$KEY_SECRET \
  -H "Content-Type: application/json" \
  -d '{
    "dashboardId": "<DASHBOARD_ID>",
    "tileId": "<TILE_ID>",
    "threshold": 100,
    "interval": "1h",
    "source": "tile",
    "thresholdType": "above",
    "channel": {
      "type": "webhook",
      "webhookId": "<WEBHOOK_ID>"
    },
    "name": "Error Spike Alert",
    "message": "Error rate exceeded 100 in the last hour"
  }' \
  https://api.clickhouse.cloud/v1/organizations/<ORG_ID>/services/<SERVICE_ID>/clickstack/alerts