Lexicon Garden

blog.pckt.domain.set

Set or update the custom domain for a publication. Returns a verification token that must be installed as a TXT record before calling verify.

Repository @pckt.blog did:plc:revjuqmkvrw6fnkxppqtszpv namespace authority
Details · procedure
Kindprocedure
Authoritydomain.pckt.blog
Indexed
Compare Edit in builder → Fork →
cid bafyreifwnoc5dbcofqmyphgnjcwzkydajbshepdsvrgjylrglh7gbazrja

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.cfHostnameVerificationTokenNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.domainNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.verificationTokenNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Set or update the custom domain for a publication. Returns a verification token that must be installed as a TXT record before calling verify.",
      "errors": [
        {
          "name": "BlogNotFound"
        },
        {
          "name": "PlanLimitReached"
        },
        {
          "name": "InvalidDomain"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "domain": {
              "description": "Fully-qualified domain name (lowercase).",
              "maxLength": 253,
              "type": "string"
            }
          },
          "required": [
            "domain"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cfHostnameVerificationToken": {
              "description": "Cloudflare ownership-verification token to install as a TXT record at _cf-custom-hostname.<domain>. Required for apex domains not already proxied through Cloudflare; absent when Cloudflare validates the hostname directly.",
              "type": "string"
            },
            "domain": {
              "type": "string"
            },
            "verificationToken": {
              "description": "Token to install as a TXT record at _pckt-verify.<domain>.",
              "type": "string"
            },
            "verified": {
              "type": "boolean"
            }
          },
          "required": [
            "domain",
            "verified"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "blog": {
            "description": "AT-URI of the publication record (site.standard.publication). Authority MUST match the caller's DID.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "blog"
        ],
        "type": "params"
      },
      "type": "procedure"
    }
  },
  "id": "blog.pckt.domain.set",
  "lexicon": 1
}