Integrations

Toggle the Google Indexing API

Changed on

Enables or disables the Google Indexing API, which notifies Google immediately when jobs are published or removed. Your site is indexed by Google either way; this only speeds up how quickly Google learns about job changes. Enabling runs the same checks as Settings → Indexing in the dashboard, in this order: the board has a primary custom domain; the board is not password protected; the board's Google Cloud project is provisioned (this starts automatically when a custom domain becomes primary); and the board's service account is an Owner of the site in Google Search Console. When Search Console is connected, the service account is added as an Owner automatically. Disabling always succeeds.

post/integrations/indexing/toggle-google-indexing-api

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/integrations/indexing/toggle-google-indexing-api
  • Auth: HTTP bearer

Request body

enabledboolean required

Whether to enable the toggle.

Response

Successful response.

id'indexing_config' required
object'indexing_config' required
enabledboolean required

Whether the Google Indexing API is enabled: Google is notified immediately when jobs are published or removed. Your site is indexed by Google either way. true means setup is complete: Cavuno only enables it after Google confirms the service account is an Owner of the Search Console property, so there is nothing left to add or verify. Use lastRunAt and lastError to check that submissions keep succeeding.

indexNowEnabledboolean required

Whether IndexNow (Bing/Yandex) instant indexing is enabled.

provisioningStatusstring nullable required

Provisioning state of the board's Google Cloud project for the Google Indexing API (pending | provisioning | ready | error), or null when setup has not started.

lastRunAtstring nullable required

ISO-8601 timestamp of the last successful Google Indexing API submission, or null. Submissions are sent when jobs are published or removed, so it stays null until the first one succeeds after indexing is enabled.

lastErrorstring nullable required

The last recorded Google Indexing API error message, or null.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status