PageGoat · Schema

SetVisibilityRequest

Set a site's link-access mode: private, password protected, email capture, or public.

File SharingLinkGenerationContentHostingDeveloper ToolsSoftware-as-a-Service

Properties

Name Type Description
visibility string Required.
publicRole stringnull Role for anyone who gets in via the link. Meaningful for password, capture and public; ignored (and cleared) for private.
password stringnull New link password. Required when switching to password mode and the site has none; omit to keep the current one. Setting it signs out everyone currently viewing. Max 128 characters.
captureOtp booleannull Whether a capture visitor must confirm a six-digit code. False is "email only, no code". Only read when visibility is `capture`; absent keeps the current setting.
captureReverifyDays integernull How many days a confirmed visitor stays confirmed. 0 means every visit re-verifies. Only read when visibility is `capture`.
captureDomains stringnull Comma- or space-separated domains a visitor's address must be at; empty for any domain. Subdomains of a listed domain are accepted. Only read when visibility is `capture`.
View JSON Schema on GitHub

JSON Schema

pagegoat-com-set-visibility-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/pagegoat-com/json-schema/pagegoat-com-set-visibility-request-schema.json",
  "title": "SetVisibilityRequest",
  "description": "Set a site's link-access mode: private, password protected, email capture, or public.",
  "x-generated": "2026-11-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/pagegoat-com-openapi.yml#/components/schemas/SetVisibilityRequest",
  "required": [
    "visibility"
  ],
  "type": "object",
  "properties": {
    "visibility": {
      "type": "string",
      "description": "Required.",
      "enum": [
        "private",
        "password",
        "capture",
        "public"
      ]
    },
    "publicRole": {
      "type": [
        "string",
        "null"
      ],
      "description": "Role for anyone who gets in via the link. Meaningful for password, capture and public; ignored (and cleared) for private.",
      "enum": [
        "viewer",
        "commenter"
      ]
    },
    "password": {
      "type": [
        "string",
        "null"
      ],
      "description": "New link password. Required when switching to password mode and the site has none; omit to keep the current one. Setting it signs out everyone currently viewing. Max 128 characters."
    },
    "captureOtp": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether a capture visitor must confirm a six-digit code. False is \"email only, no code\". Only read when visibility is `capture`; absent keeps the current setting."
    },
    "captureReverifyDays": {
      "type": [
        "integer",
        "null"
      ],
      "description": "How many days a confirmed visitor stays confirmed. 0 means every visit re-verifies. Only read when visibility is `capture`.",
      "format": "int32"
    },
    "captureDomains": {
      "type": [
        "string",
        "null"
      ],
      "description": "Comma- or space-separated domains a visitor's address must be at; empty for any domain. Subdomains of a listed domain are accepted. Only read when visibility is `capture`."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pagegoat-com-set-visibility-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.