Klineo/Docs
Open app ↗

API schemas

PartnerDomainChallenge

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
id Yes string Format: uuid
organizationId Yes string Min length: 3; Max length: 160
partnerId Yes string Min length: 3; Max length: 160
domain Yes string Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$; Min length: 3; Max length: 232
createdBy Yes string Format: uuid
createdAt Yes string Format: date-time
expiresAt Yes string Format: date-time
version Yes integer Minimum: 1
challengeHash Yes Hash —
dns Yes PartnerDomainDnsRecord —
state Yes string Allowed: PENDING, VERIFIED, REVOKED
verification Yes At least one of: object; null —
verification.anyOf[1].domain Yes string Pattern: ^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,63}$; Min length: 3; Max length: 253
verification.anyOf[1].providerId Yes string Pattern: ^[a-zA-Z0-9][a-zA-Z0-9:_-]{2,159}$
verification.anyOf[1].providerKeyResourceVersion Yes Hash —
verification.anyOf[1].providerAttestationHash Yes Hash —
verification.anyOf[1].challengeHash Yes Hash —
verification.anyOf[1].observedAt Yes string Format: date-time
verification.anyOf[1].validUntil Yes string Format: date-time
verification.anyOf[1].signature Yes string Pattern: ^[A-Za-z0-9+/]{80,700}={0,2}$
customHostname Yes At least one of: PartnerCustomHostname; null —
provisioningOperation No At least one of: object; null —
provisioningOperation.anyOf[1].id Yes string Format: uuid
provisioningOperation.anyOf[1].startedAt Yes string Format: date-time

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/PartnerDomainChallenge in the OpenAPI contract.