place.wisp.v2.domains

wisp.place

Documentation

Domain registration metadata for wisp.place subdomains and custom domains.

main record

Domain registration metadata for wisp.place subdomains and custom domains.

Record Key any Any valid record key

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

domain string Required

Lowercase FQDN for this registration (for example, alice.wisp.place or example.com).

maxLength: 253 bytesminLength: 3 bytes
siteRkey string record-key Optional

Optional place.wisp.fs record key currently mapped to this domain.

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "domain",
      "registration",
      "createdAt",
      "updatedAt"
    ],
    "properties": {
      "domain": {
        "type": "string",
        "maxLength": 253,
        "minLength": 3,
        "description": "Lowercase FQDN for this registration (for example, alice.wisp.place or example.com)."
      },
      "siteRkey": {
        "type": "string",
        "format": "record-key",
        "description": "Optional place.wisp.fs record key currently mapped to this domain."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      },
      "registration": {
        "refs": [
          "#wispRegistration",
          "#customRegistration"
        ],
        "type": "union"
      }
    }
  },
  "description": "Domain registration metadata for wisp.place subdomains and custom domains."
}
customRegistration object

Registration metadata for a custom domain.

Properties

challengeId string Required

Challenge identifier used to derive DNS setup instructions.

maxLength: 64 bytesminLength: 8 bytes
kind string Required

No description available.

verification ref #verification Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "kind",
    "challengeId",
    "verification"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "custom"
    },
    "challengeId": {
      "type": "string",
      "maxLength": 64,
      "minLength": 8,
      "description": "Challenge identifier used to derive DNS setup instructions."
    },
    "verification": {
      "ref": "#verification",
      "type": "ref"
    }
  },
  "description": "Registration metadata for a custom domain."
}
verification object

Latest verification state for a custom domain.

Properties

lastCheckedAt string datetime Optional

An RFC 3339 formatted timestamp.

lastError string Optional

No description available.

maxLength: 1000 bytes
method string Required

No description available.

status string Required

No description available.

verifiedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema 
{
  "type": "object",
  "required": [
    "status",
    "method"
  ],
  "properties": {
    "method": {
      "enum": [
        "txt-did-v1"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "pending",
        "verified",
        "failed"
      ],
      "type": "string"
    },
    "lastError": {
      "type": "string",
      "maxLength": 1000
    },
    "verifiedAt": {
      "type": "string",
      "format": "datetime"
    },
    "lastCheckedAt": {
      "type": "string",
      "format": "datetime"
    }
  },
  "description": "Latest verification state for a custom domain."
}
wispRegistration object

Registration for a first-party subdomain under the wisp.place base host.

Properties

handle string Required

Subdomain label only (for example, alice).

maxLength: 63 bytesminLength: 3 bytes
kind string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "kind",
    "handle"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "const": "wisp"
    },
    "handle": {
      "type": "string",
      "maxLength": 63,
      "minLength": 3,
      "description": "Subdomain label only (for example, alice)."
    }
  },
  "description": "Registration for a first-party subdomain under the wisp.place base host."
}

Lexicon Garden

@