사용자 지정 도메인 추가

POST /v1/custom-domains · 권한 custom-domains:write

환경에 사용자 지정 로그인 도메인을 추가합니다. 이름은 IDNA2008 A-레이블로 변환되며 공개 접미사, 단일 레이블 이름, IP 주소, 플랫폼 도메인은 거부됩니다. 이름은 플랫폼 전체에서 고유합니다. 다른 환경이 사용 중이거나 해제된 지 30일이 지나지 않았으면(격리) 409 custom_domain_taken으로 실패합니다. 도메인은 pending_dns 상태로 시작합니다. 반환된 dns_records(영구 TXT 소유권 레코드와 환경의 엣지 호스트를 가리키는 CNAME)를 DNS 제공업체에 게시한 다음 :verify를 호출하거나 자동 검사를 기다리세요.

요청

JSON 본문 (알 수 없는 필드는 400 unknown_field로 거부됨):

필드 유형 필수 설명
Idempotency-Key header 예 필수. 16-64자 [A-Za-z0-9_-]. 같은 키를 같은 이름으로 반복하면 같은 도메인을 반환합니다.
hostname string 예 추가할 도메인(유니코드 가능), 최대 253바이트. 예: login.example.com.

응답

201 Created와 도메인, ETag 헤더.

{
  "id": "cdom_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "hostname": "login.example.com",
  "is_primary": false,
  "status": "pending_dns",
  "failure_reason": null,
  "dns_records": [
    {
      "type": "TXT",
      "name": "_akp-verify.login.example.com",
      "value": "idp-verify=3q2-7wEXAMPLEtokenQ9"
    },
    {
      "type": "CNAME",
      "name": "login.example.com",
      "value": "acme.eu.edge.keenauth.app"
    }
  ],
  "certificate_expires_at": null,
  "last_checked_at": null,
  "next_check_at": "2026-10-05T09:36:00Z",
  "activated_at": null,
  "degraded_since": null,
  "status_changed_at": "2026-10-05T09:30:00.123456Z",
  "created_at": "2026-10-05T09:30:00.123456Z",
  "updated_at": "2026-10-05T09:30:00.123456Z"
}

오류

HTTP code 조건
400 malformed_request Idempotency-Key가 없거나 형식이 잘못되었습니다.
400 unknown_field 본문에 알 수 없는 필드가 있습니다.
403 quota_exceeded 환경의 사용자 지정 도메인 할당량이 찼거나 환경이 development 환경입니다.
409 custom_domain_taken 이름을 다른 환경이 사용 중이거나 30일 격리 기간입니다.
409 conflict 계정 또는 환경이 활성 상태가 아닙니다.
415 unsupported_media_type 콘텐츠 유형이 application/json이 아닙니다.
422 validation_failed hostname이 사용자 지정 도메인으로 유효한 도메인 이름이 아닙니다.
422 idempotency_key_reuse Idempotency-Key가 다른 본문으로 이미 사용되었습니다.
429 rate_limited 오늘 계정의 사용자 지정 도메인 추가 시도가 너무 많습니다. Retry-After 시간 후에 다시 시도하세요.
503 service_unavailable 플랫폼 도메인 레지스트리 또는 환경의 계정 정보를 일시적으로 사용할 수 없습니다.
401 unauthenticated 자격 증명이 없거나 유효하지 않거나 취소되었습니다.
403 insufficient_permissions 자격 증명에 필요한 권한이 없습니다.

예제

curl -X POST https://api.eu.keenauth.com/v1/custom-domains \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"hostname":"login.example.com"}'