Skip to content

API reference

SiteHealthRequest ​

Type: object, no additional properties

  • php_version (required): string, pattern: ^[0-9A-Za-z.+_ -]{1,32}$

    Up to 32 letters, digits, dots, dashes, underscores, plus signs and spaces.

  • plugin_version (required): string, pattern: ^[0-9A-Za-z.+_ -]{1,32}$

    Up to 32 letters, digits, dots, dashes, underscores, plus signs and spaces.

  • wp_version (required): string, pattern: ^[0-9A-Za-z.+_ -]{1,32}$

    Up to 32 letters, digits, dots, dashes, underscores, plus signs and spaces.

  • 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/.

  • last_sync_at: string | null, format: date-time, pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

    When the plugin last finished a sync.

  • sync_error_count: integer, minimum: 0, maximum: 1000000

    Sync errors since the last report. Default 0.

Was this page helpful?