Set the IndexNow API key
update_indexnow_settingsSets, generates, rotates or clears the IndexNow API key for a property. The key is what search engines use to verify submissions from submit_indexnow_urls. To set IndexNow up, pass generateKey: true: a valid key is created and returned with keyFileUrl and keyFileContent. IMPORTANT: the site owner must then publish keyFileContent as a plain-text file at keyFileUrl (at the root of every host whose URLs will be submitted), or every submission is discarded. generateKey refuses to replace an existing key; to rotate, pass clear: true first. You can also pass your own indexnowApiKey (8-128 letters, digits and hyphens), for example one whose key file the site already publishes: the file is checked right after saving and keyFileVerified reports the result (true = ready to submit). Pass clear: true to remove the key, which disables IndexNow submissions for the property. Reading the key back later (get_indexnow_settings) only ever returns it masked.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clear | No | Remove the stored key instead of setting one. Disables IndexNow submissions. | |
| siteUrl | Yes | ||
| generateKey | No | Create a new valid key and return the key file to publish. Only when the property has no key yet; clear the old key first to rotate. | |
| indexnowApiKey | No | The new key. Omit when using generateKey or clear. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cleared | No | ||
| siteUrl | No | ||
| nextStep | No | ||
| generated | No | ||
| keyFileUrl | No | ||
| keyFileUrls | No | ||
| keyFileError | No | ||
| keyFileContent | No | ||
| keyFileVerified | No | ||
| indexnowApiKeySet | No | ||
| indexnowApiKeyMasked | No |