Lexicon Garden

place.wisp.v2.privateSite.createShare

Create a share link for an owned private site. The returned token is the access credential and is shown exactly once; only its hash is stored. A share can never outlive its site, so its expiry is clamped to the site's expiry.

Repository @wisp.place did:plc:7puq73yz2hkvbcpdhnsze2qw not from the namespace authority
Details · procedure
Kindprocedure
AuthorityprivateSite.v2.wisp.place
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

audienceDid

string · did

Restrict this link to a single account. The recipient must be signed in as this DID; the link alone grants nothing. Omit for a bearer link that anyone holding the URL can open, including people without an atproto account.

expiryMinutes

integer

Minutes until this link expires. Omit for the configured default; 0 for no expiry of its own.

  • minimum: 0

label

string

Optional human label for this link.

  • maxLength: 128

siteId

requiredstring · record-key

Output

application/json

audienceDid

string · did

Set when this link is restricted to a single account.

createdAt

requiredstring · datetime

directUrl

string · uri

The same credential on the site's own origin. Equivalent to `url`; useful when a link should not route through wisp.place.

expiresAt

string · datetime

shareId

requiredstring

siteId

requiredstring · record-key

url

requiredstring

Short, human-friendly share link (wisp.place/p/<token>). Contains the credential and is returned exactly once.

Errors

AuthenticationRequired

No description in schema.

InvalidRequest

No description in schema.

NotFound

No description in schema.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • place.wisp.v2.privateSite.listShares

    query not from the namespace authority

    List share links for an owned private site. Never returns share tokens, only their non-secret display prefix.

  • place.wisp.v2.privateSite.create

    procedure not from the namespace authority

    Create a private site from an uploaded archive. Private sites are stored only by the wisp hosting service and are never written to the owner's PDS, because atproto repo records and blobs are publicly readable and broadcast over the firehose. Access is granted to the owner's authenticated account and to any share links they create.