API reference

RegisterSiteRequest

Type: object, no additional properties

• code_challenge (required): string, pattern: ^[A-Za-z0-9_-]{43}$

  The S256 challenge: base64url of the SHA-256 of the plugin verifier. show.fm fetches the plugin challenge for state and must get this back.

• rest_root (required): string, minLength: 1, maxLength: 2048

  WordPress rest_url(): after normalising the host to lowercase IDNA, exactly the normalised site_url plus /wp-json/, /?rest_route=/ or /index.php?rest_route=/. The path keeps its case.

• site_url (required): string

  The site's https address, with no query, fragment, port or login details.

• state (required): string, pattern: ^[A-Za-z0-9_-]{32,128}$

  A fresh random value the plugin stored before calling, 32 to 128 URL-safe characters.

• admin_url: string, minLength: 1, maxLength: 2048

  Optional WordPress admin address for reconnect links. Must be https, on the same origin as site_url, under its home path and contain /wp-admin/, with no credentials, port or fragment. Stored as the plugin settings address. Omit to preserve an existing address; older connections without one use the site home path plus /wp-admin/.