place.wisp.v2.site.delete Documentation (EN)

main procedure

Delete one owned site metadata entry and unmap any domains pointing to it.

Input

Encodingapplication/json

siteRkey stringrecord-key Required

Owned place.wisp.fs record key to delete from wisp metadata.

Output

Encodingapplication/json

deleted boolean Required

No description available.

siteRkey stringrecord-key Required

A valid record key for AT Protocol repositories.

unmappedDomains array Required

Domains that were detached from this site before deletion.

Errors

AuthenticationRequired

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": [
        "siteRkey"
      ],
      "properties": {
        "siteRkey": {
          "type": "string",
          "format": "record-key",
          "description": "Owned place.wisp.fs record key to delete from wisp metadata."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "InvalidRequest"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "siteRkey",
        "deleted",
        "unmappedDomains"
      ],
      "properties": {
        "deleted": {
          "type": "boolean",
          "const": true
        },
        "siteRkey": {
          "type": "string",
          "format": "record-key"
        },
        "unmappedDomains": {
          "type": "array",
          "items": {
            "ref": "#unmappedDomain",
            "type": "ref"
          },
          "description": "Domains that were detached from this site before deletion."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Delete one owned site metadata entry and unmap any domains pointing to it."
}

unmappedDomain object

No description available.

Properties

domain string Required

No description available.

maxLength: 253 bytesminLength: 3 bytes

kind string Required

No description available.

status string Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "domain",
    "kind",
    "status"
  ],
  "properties": {
    "kind": {
      "enum": [
        "wisp",
        "custom"
      ],
      "type": "string"
    },
    "domain": {
      "type": "string",
      "maxLength": 253,
      "minLength": 3
    },
    "status": {
      "enum": [
        "pendingVerification",
        "verified"
      ],
      "type": "string"
    }
  }
}