place.wisp.v2.domain.addSite Documentation (EN)

main procedure

Map an owned domain to one owned site record.

Input

Encodingapplication/json

domain string Required

Fully-qualified domain to map.

maxLength: 253 bytesminLength: 3 bytes

siteRkey stringrecord-key Required

Owned place.wisp.fs record key to map this domain to.

Output

Encodingapplication/json

domain string Required

No description available.

kind string Required

No description available.

mapped boolean Required

No description available.

siteRkey stringrecord-key Required

A valid record key for AT Protocol repositories.

status string Required

No description available.

Errors

AuthenticationRequired

InvalidDomain

InvalidRequest

NotFound

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "domain",
        "siteRkey"
      ],
      "properties": {
        "domain": {
          "type": "string",
          "maxLength": 253,
          "minLength": 3,
          "description": "Fully-qualified domain to map."
        },
        "siteRkey": {
          "type": "string",
          "format": "record-key",
          "description": "Owned place.wisp.fs record key to map this domain to."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "InvalidDomain"
    },
    {
      "name": "InvalidRequest"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "domain",
        "kind",
        "status",
        "siteRkey",
        "mapped"
      ],
      "properties": {
        "kind": {
          "enum": [
            "wisp",
            "custom"
          ],
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "mapped": {
          "type": "boolean",
          "const": true
        },
        "status": {
          "enum": [
            "pendingVerification",
            "verified"
          ],
          "type": "string"
        },
        "siteRkey": {
          "type": "string",
          "format": "record-key"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Map an owned domain to one owned site record."
}