API 레퍼런스

Status Page API

상태 페이지 조회와 부분 수정, 커스텀 도메인 검증 endpoint를 설명합니다.

Endpoint

Method	Path	설명
`GET`	`/api/v1/status-page`	상태 페이지 조회
`PATCH`	`/api/v1/status-page`	설정 부분 수정
`GET`	`/api/v1/status-page/domain-verification`	DNS와 HTTPS 연결 확인

모든 endpoint는 관리 API 인증을 사용합니다.

조회

bash

curl -sS https://crm.theseeker.io/api/v1/status-page \
  -H "Authorization: Bearer $THESEEKER_API_KEY"

성공 응답은 statusPage 안에 enabled, slug, title, description, customDomain, publicUrl, customDomainUrl, components를 포함합니다. 페이지가 없으면 404 NOT_FOUND입니다.

부분 수정

허용 필드는 enabled, slug, title, description, customDomain입니다. 생략한 필드는 유지됩니다.

bash

curl -X PATCH https://crm.theseeker.io/api/v1/status-page \
  -H "Authorization: Bearer $THESEEKER_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"customDomain":"status.example.com"}'

customDomain: null은 도메인을 제거합니다. 잘못된 필드는 400, slug 충돌은 409 SLUG_TAKEN입니다.

도메인 검증

검증 결과의 status는 dns_missing, dns_mismatch, dns_ok_tls_pending, active 중 하나입니다. active는 라우팅 확인이며 소유권 증명은 아닙니다.

이 페이지가 도움이 되었나요?

API 레퍼런스

Status Page API

상태 페이지 조회와 부분 수정, 커스텀 도메인 검증 endpoint를 설명합니다.

Endpoint

Method	Path	설명
`GET`	`/api/v1/status-page`	상태 페이지 조회
`PATCH`	`/api/v1/status-page`	설정 부분 수정
`GET`	`/api/v1/status-page/domain-verification`	DNS와 HTTPS 연결 확인

모든 endpoint는 관리 API 인증을 사용합니다.

조회

bash

curl -sS https://crm.theseeker.io/api/v1/status-page \
  -H "Authorization: Bearer $THESEEKER_API_KEY"

부분 수정

허용 필드는 enabled, slug, title, description, customDomain입니다. 생략한 필드는 유지됩니다.

bash

curl -X PATCH https://crm.theseeker.io/api/v1/status-page \
  -H "Authorization: Bearer $THESEEKER_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"customDomain":"status.example.com"}'

customDomain: null은 도메인을 제거합니다. 잘못된 필드는 400, slug 충돌은 409 SLUG_TAKEN입니다.

도메인 검증

검증 결과의 status는 dns_missing, dns_mismatch, dns_ok_tls_pending, active 중 하나입니다. active는 라우팅 확인이며 소유권 증명은 아닙니다.

이 페이지가 도움이 되었나요?