Check IndexNow key file and sitemap
indexnow_checkChecks a site's IndexNow setup and submits nothing. Use it when the user asks whether their IndexNow key file works, which URLs would be submitted, or how to start with IndexNow, for example "is my IndexNow key set up on example.com?". Pass site and key; leave key out to get a new key and the file to publish. Returns the key file verdict with the exact fix, the sitemap found (robots.txt, index, gzip), how many URLs qualify, why others are left out, a sample, and the next step. Protocol: https://www.indexnow.org/documentation. Do not use it for a site the user does not own, or to read a site's content.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | The site's IndexNow key, 8 to 128 letters, digits or dashes. Leave it out to get a new key and the exact file to publish. | |
| site | Yes | The site's domain or address, such as example.com or https://www.example.com. A bare domain means https. One host per call: www.example.com and example.com are different hosts. | |
| urls | No | Optional list of URLs to send instead of the sitemap, all on the site's host. At most 10,000. | |
| batch | No | Optional, default 1. When more URLs qualify than one submit takes, batch 2 is the next slice of the newest-first list, and so on; urls.batches says how many there are. | |
| sitemap | No | Optional sitemap or sitemap index address. Without it the Sitemap lines of robots.txt are used, then /sitemap.xml, /sitemap_index.xml and /wp-sitemap.xml. Gzip files work. | |
| max_urls | No | Optional URLs per submit, default 10,000. When more URLs qualify, the newest lastmod goes first and the rest wait for the next batch. | |
| path_prefix | No | Optional path start, such as /blog/. Only URLs under it. | |
| key_location | No | Optional https address of the key file when it is not at /<key>.txt. It must be on the same host and end in .txt; it then covers only URLs in its folder and below. | |
| changed_since | No | Optional YYYY-MM-DD. Only sitemap URLs whose lastmod is on or after this day; URLs with no lastmod are left out. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | ||
| site | Yes | ||
| urls | Yes | ||
| as_of | Yes | ||
| ready | Yes | ||
| ad_line | Yes | ||
| engines | Yes | ||
| new_key | Yes | ||
| sitemap | Yes | ||
| key_file | Yes | ||
| protocol | Yes | ||
| url_list | No | ||
| next_step | Yes |