space.highport.manage.setDelegationDefaultTile

lexicons.highport.space

Documentation

Set or clear the tile served on every name reserved under a delegation base whose subject has not yet published a site. The tile is pinned by CID and takes no parameters, so a tile with a required parameter is refused. It never answers /.well-known/atproto-did, which keeps returning the DID the name is reserved for. The base owner pays for the traffic. The caller must own the base, which must have delegation enabled.

main procedure

Set or clear the tile served on every name reserved under a delegation base whose subject has not yet published a site. The tile is pinned by CID and takes no parameters, so a tile with a required parameter is refused. It never answers /.well-known/atproto-did, which keeps returning the DID the name is reserved for. The base owner pays for the traffic. The caller must own the base, which must have delegation enabled.

Input

Encodingapplication/json
domain string Required

The base: a domain registered to the caller, with delegation enabled.

maxLength: 253 bytes
tile refcom.atproto.repo.strongRef Optional

The tile to serve, pinning the exact version. Absent clears the default, and the names go back to answering only /.well-known/atproto-did.

Output

Encodingapplication/json
domain string Required

No description available.

queued integer Required

How many reserved names the change was queued for. Names whose subject has already published are not included; their own site keeps serving.

Errors

InvalidDomain Not a syntactically valid domain.
NotBaseOwner No verified or active registration of that domain belongs to the caller.
DelegationNotEnabled The domain is not a delegation base. Enable delegation before setting a default tile.
DefaultTilesUnsupported This deployment does not offer default tiles.
TileNotFound No tile is known at that URI and CID. A tile is bindable once this service has indexed it.
TileNotReady The tile is known but not ready: it is still indexing, its resources are incomplete, or it has been suspended.
TileNotPublic The tile belongs to a space. A space's tiles are private to it and cannot be served on a reserved name.
TileRequiresParameters The tile declares a required parameter. A default tile is bound with no parameters and nothing can supply one, so only a tile whose parameters are all optional can be a default. The error message names the parameters.
TileClaimsReservedPath The tile's content defines an entry at /.well-known/atproto-did. That path resolves the handle of the identity the name is reserved for, and a default tile may not answer it.
Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "domain"
      ],
      "properties": {
        "tile": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref",
          "description": "The tile to serve, pinning the exact version. Absent clears the default, and the names go back to answering only /.well-known/atproto-did."
        },
        "domain": {
          "type": "string",
          "maxLength": 253,
          "description": "The base: a domain registered to the caller, with delegation enabled."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidDomain",
      "description": "Not a syntactically valid domain."
    },
    {
      "name": "NotBaseOwner",
      "description": "No verified or active registration of that domain belongs to the caller."
    },
    {
      "name": "DelegationNotEnabled",
      "description": "The domain is not a delegation base. Enable delegation before setting a default tile."
    },
    {
      "name": "DefaultTilesUnsupported",
      "description": "This deployment does not offer default tiles."
    },
    {
      "name": "TileNotFound",
      "description": "No tile is known at that URI and CID. A tile is bindable once this service has indexed it."
    },
    {
      "name": "TileNotReady",
      "description": "The tile is known but not ready: it is still indexing, its resources are incomplete, or it has been suspended."
    },
    {
      "name": "TileNotPublic",
      "description": "The tile belongs to a space. A space's tiles are private to it and cannot be served on a reserved name."
    },
    {
      "name": "TileRequiresParameters",
      "description": "The tile declares a required parameter. A default tile is bound with no parameters and nothing can supply one, so only a tile whose parameters are all optional can be a default. The error message names the parameters."
    },
    {
      "name": "TileClaimsReservedPath",
      "description": "The tile's content defines an entry at /.well-known/atproto-did. That path resolves the handle of the identity the name is reserved for, and a default tile may not answer it."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "domain",
        "queued"
      ],
      "properties": {
        "domain": {
          "type": "string"
        },
        "queued": {
          "type": "integer",
          "description": "How many reserved names the change was queued for. Names whose subject has already published are not included; their own site keeps serving."
        },
        "defaultTile": {
          "ref": "space.highport.defs#defaultTileView",
          "type": "ref",
          "description": "The stored binding. Absent when the default was cleared."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Set or clear the tile served on every name reserved under a delegation base whose subject has not yet published a site. The tile is pinned by CID and takes no parameters, so a tile with a required parameter is refused. It never answers /.well-known/atproto-did, which keeps returning the DID the name is reserved for. The base owner pays for the traffic. The caller must own the base, which must have delegation enabled."
}

Lexicon Garden

@